华为云用户手册

  • 响应参数 状态码: 200 表10 响应Body参数 参数 参数类型 描述 result String 参数解释: 请求结果。 取值范围: SUC CES S:请求成功。 FAIL:请求失败。 默认取值: 不涉及。 data Array of objects 参数解释: 请求参数对象。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 errors Array of strings 参数解释: 异常信息。 取值范围: 不涉及。 默认取值: 不涉及。
  • 请求示例 POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/MultiViewModel/updateView { "applicationId" : "b3f9b7523a6141f4b2d76b92d6595281", "params" : { "versionId" : "1", "newViewAttrs" : { "item" : { "id" : "1", "clazz" : "MultiViewItem" } } } }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释: IAM 用户的token。 获取方法请参见获取IAM用户Token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 params 否 VersionUpdateViewDTOMultiViewModelViewUpdateAttrDTO object 参数解释: 请求参数对象。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 applicationId 否 String 参数解释: 应用ID。 约束限制: 不涉及。 取值范围: 由英文字母和数字组成,且长度为32个字符。 默认取值: 不涉及。 表4 VersionUpdateViewDTOMultiViewModelViewUpdateAttrDTO 参数 是否必选 参数类型 描述 versionId 是 String 参数解释: 版本对象ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 newViewAttrs 是 MultiViewModelViewUpdateAttrDTO object 参数解释: 更新的视图对象。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 needSetNull 否 Array of strings 参数解释: 指定不复制的视图属性,其值将被设置为null。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 表5 MultiViewModelViewUpdateAttrDTO 参数 是否必选 参数类型 描述 item 否 ObjectReferenceParamDTO object 参数解释: 引用对象。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 表6 ObjectReferenceParamDTO 参数 是否必选 参数类型 描述 clazz 否 String 参数解释: 类名。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 id 是 String 参数解释: 数据实例 ID。 约束限制: 不涉及。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。
  • 响应参数 状态码: 200 表7 响应Body参数 参数 参数类型 描述 result String 参数解释: 请求结果。 取值范围: SUCCESS:请求成功。 FAIL:请求失败。 默认取值: 不涉及。 data Array of integers 参数解释: 请求数据。 取值范围: 不涉及。 默认取值: 不涉及。 errors Array of strings 参数解释: 异常信息。 取值范围: 不涉及。 默认取值: 不涉及。
  • URI POST /rdm_{identifier}_app/publicservices/api/{modelName}/updateView 表1 路径参数 参数 是否必选 参数类型 描述 identifier 是 String 参数解释: 应用唯一标识。 约束限制: 不涉及。 取值范围: 由英文字母和数字组成,且长度为32个字符。 默认取值: 不涉及。 modelName 是 String 参数解释: 数据模型的英文名称。 约束限制: 不涉及。 取值范围: 大写字母开头,只能包含字母、数字、"_",且长度为[1-60]个字符。 默认取值: 不涉及。
  • 请求示例 POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/VersionModel/logicalDeleteLatestVersion { "applicationId" : "b3f9b7523a6141f4b2d76b92d6595281", "params" : { "modifier" : "test1", "masterId" : "602425926667476992", "version" : "A" } }
  • URI POST /rdm_{identifier}_app/publicservices/api/{modelName}/logicalDeleteLatestVersion 表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 否 VersionModelVersionMasterModifierDTO object 参数解释: 请求参数对象。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 表4 VersionModelVersionMasterModifierDTO 参数 是否必选 参数类型 描述 masterId 是 String 参数解释: 父模型ID。 约束限制: 不涉及。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。 modifier 否 String 参数解释: 修改人。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 version 否 String 参数解释: 版本对象。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 result String 参数解释: 请求结果。 取值范围: SUCCESS:请求成功。 FAIL:请求失败。 默认取值: 不涉及。 data Array of integers 参数解释: 请求数据。 取值范围: 不涉及。 默认取值: 不涉及。 errors Array of strings 参数解释: 异常信息。 取值范围: 不涉及。 默认取值: 不涉及。
  • 请求示例 POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/PersistableModel/saveAs { "applicationId" : "b3f9b7523a6141f4b2d76b92d6595281", "params" : { "sourceInstanceId" : "1", "tenant" : { "id" : "-1", "clazz" : "Tenant" }, "rdmExtensionType" : "PersistableModel", "creator" : "test1", "modifier" : "test1", "uniqueKey" : "saveAs接口另存", "needSetNullAttrs" : [ ] } }
  • 响应示例 状态码: 200 OK { "result" : "SUCCESS", "data" : [ { "id" : "574609957815586816", "creator" : "test1", "modifier" : "XDM_Developer xxx", "createTime" : "2023-12-08T06:54:49.680+0000", "lastUpdateTime" : "2023-12-08T06:54:49.680+0000", "rdmVersion" : 1, "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" : null } ], "errors" : [ ] }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释: IAM用户的token。 获取方法请参见获取IAM用户Token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 params 否 PersistableModelSaveAsDTO object 参数解释: 请求参数对象。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 applicationId 否 String 参数解释: 应用ID。 约束限制: 不涉及。 取值范围: 由英文字母和数字组成,且长度为32个字符。 默认取值: 不涉及。 表4 PersistableModelSaveAsDTO 参数 是否必选 参数类型 描述 id 否 String 参数解释: 唯一标识。 约束限制: 不涉及。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。 modifier 否 String 参数解释: 修改者。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 lastUpdateTime 否 String 参数解释: 最后更新时间。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 creator 否 String 参数解释: 创建者。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 createTime 否 String 参数解释: 创建时间。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 rdmExtensionType 否 String 参数解释: 扩展类型。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 tenant 否 ObjectReferenceParamDTO object 参数解释: 租户信息。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 sourceEntityNumber 否 String 参数解释: 源模型编号。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 sourceInstanceId 是 String 参数解释: 源实例的唯一标识(单实例为ID,版本实例为versionId)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 needSetNullAttrs 否 Array of strings 参数解释: 置空字段数组。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 entityToSave 否 Object 参数解释: 要保存的属性。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 entityToReturn 否 Object 参数解释: 要保存的结果。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 uniqueKey 否 String 参数解释: 唯一键约束属性。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 表5 ObjectReferenceParamDTO 参数 是否必选 参数类型 描述 clazz 否 String 参数解释: 类名。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 id 是 String 参数解释: 数据实例ID。 约束限制: 不涉及。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。
  • 响应参数 状态码: 200 表6 响应Body参数 参数 参数类型 描述 result String 参数解释: 请求结果。 取值范围: SUCCESS:请求成功。 FAIL:请求失败。 默认取值: 不涉及。 data Array of PersistableModelViewDTO objects 参数解释: 请求数据。 取值范围: 不涉及。 默认取值: 不涉及。 errors Array of strings 参数解释: 异常信息。 取值范围: 不涉及。 默认取值: 不涉及。 表7 PersistableModelViewDTO 参数 参数类型 描述 className String 参数解释: 类名。 取值范围: 不涉及。 默认取值: 不涉及。 createTime String 参数解释: 创建时间。 取值范围: 不涉及。 默认取值: 不涉及。 creator String 参数解释: 创建者。 取值范围: 不涉及。 默认取值: 不涉及。 id String 参数解释: 唯一标识。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。 rdmDeleteFlag Integer 参数解释: 软删除标识。 取值范围: 0:表示未删除。 1:表示已删除。 默认取值: 0。 rdmExtensionType String 参数解释: 扩展类型。 取值范围: 不涉及。 默认取值: 不涉及。 rdmVersion Integer 参数解释: 系统版本。 取值范围: 不涉及。 默认取值: 不涉及。 modifier String 参数解释: 修改人。 取值范围: 不涉及。 默认取值: 不涉及。 lastUpdateTime Object 参数解释: 最后更新时间。 取值范围: 不涉及。 默认取值: 不涉及。 tenant TenantViewDTO object 参数解释: 租户信息。 取值范围: 不涉及。 默认取值: 不涉及。 uniqueKey String 参数解释: 示例模型中定义的唯一键属性。 取值范围: 不涉及。 默认取值: 不涉及。 表8 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 参数解释: 租户信息。 取值范围: 不涉及。 默认取值: 不涉及。
  • URI POST /rdm_{identifier}_app/publicservices/api/{modelName}/saveAs 表1 路径参数 参数 是否必选 参数类型 描述 identifier 是 String 参数解释: 应用唯一标识。 约束限制: 不涉及。 取值范围: 由英文字母和数字组成,且长度为32个字符。 默认取值: 不涉及。 modelName 是 String 参数解释: 数据模型的英文名称。 约束限制: 不涉及。 取值范围: 大写字母开头,只能包含字母、数字、"_",且长度为[1-60]个字符。 默认取值: 不涉及。
  • 响应示例 状态码: 200 OK { "result" : "SUCCESS", "data" : [ { "id" : "601818968927248384", "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" : "601815482655318016", "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" : "601818968927248385", "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" : null } ], "errors" : [ ] }
  • 请求示例 POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/VersionModel/revise { "applicationId" : "b3f9b7523a6141f4b2d76b92d6595281", "params" : { "creator" : "test1", "modifier" : "test1", "customLinkSet" : [ ], "masterId" : "601815482655318016", "workCopyType" : "BOTH", "workingCopy" : false } }
  • 响应参数 状态码: 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 否 VersionModelVersionReviseDTO object 参数解释: 请求参数对象。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 表4 VersionModelVersionReviseDTO 参数 是否必选 参数类型 描述 creator 否 String 参数解释: 创建人。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 customLinkSet 否 Array of strings 参数解释: 关系实体名称集合,与workCopyType的值CUSTOM配合使用。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 masterId 是 String 参数解释: 主对象ID。 约束限制: 不涉及。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。 modifier 否 String 参数解释: 更新者。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 workCopyType 否 String 参数解释: 关系的复制类型。 约束限制: 不涉及。 取值范围: BOTH:若存在关系实例引用此数据实例作为源端实例或目标端实例,修订后的数据实例将继承这些关系实例。 SOURCE:若存在关系实例引用此数据实例作为源端实例,修订后的数据实例将继承这些关系实例。 TARGET:若存在关系实例引用此数据实例作为目标端实例,修订后的数据实例将继承这些关系实例。 NONE:修订后的数据实例将不继承任何关系实例。 CUSTOM:若指定的关系实体集合对应的关系实例引用此数据实例作为源端实例或目标端实例,修订后的数据实例将继承这些关系实例。 默认取值: 不涉及。 workingCopy 否 Boolean 参数解释: 是否已检出。 约束限制: 不涉及。 取值范围: true:已检出。 false:未检出。 默认取值: false。
  • URI POST /rdm_{identifier}_app/publicservices/api/{modelName}/revise 表1 路径参数 参数 是否必选 参数类型 描述 identifier 是 String 参数解释: 应用唯一标识。 约束限制: 不涉及。 取值范围: 由英文字母和数字组成,且长度为32个字符。 默认取值: 不涉及。 modelName 是 String 参数解释: 数据模型的英文名称。 约束限制: 不涉及。 取值范围: 大写字母开头,只能包含字母、数字、"_",且长度为[1-60]个字符。 默认取值: 不涉及。
  • 请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 [数组元素] 否 Array of OpenWoDTO objects 被导入工单信息 表2 OpenWoDTO 参数 是否必选 参数类型 描述 wo_order 是 String 工单号 erp_wo_order 否 String ERP工单号 parent_wo_order 否 String 父项工单号 part_no 是 String 产品编码 part_revision 是 String 版本 lot_unit 否 Integer 产品单LOT批量 wo_qty 是 Integer 工单批量 site_no 是 String 加工区域代码 data_source 否 String 数据来源
  • 响应示例 状态码: 200 请求成功 { "status" : "200", "message" : "success", "data" : [ "1" ] } 状态码: 400 参数校验异常 { "error_code" : " IDT .0604xxxx", "error_msg" : "xxx does not exist" } 状态码: 500 API执行异常 { "error_code" : "IDT.0604xxxx", "error_msg" : "xxx does not exist" }
  • 请求示例 /v1/wos/batch-create [ { "wo_order" : "WOP123456", "erp_wo_order" : "QWERTYUI", "parent_wo_order" : "WOP147369", "part_no" : "TEST2023", "part_revision" : "1", "lot_unit" : 1, "wo_qty" : 100, "site_no" : "TEST210213", "data_source" : "MANUAL" } ]
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 [数组元素] Array of strings 请求成功 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误代码 error_msg String 错误信息 状态码: 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误代码 error_msg String 错误信息
  • 响应示例 状态码: 200 OK { "result" : "SUCCESS", "data" : [ { "id" : "616948972547739648", "creator" : "xdmAdmin", "createTime" : "2024-04-03T02:54:57.413+0000", "modifier" : "xdmAdmin", "lastUpdateTime" : "2024-04-03T02:54:57.413+0000", "rdmExtensionType" : "TreeableModel", "tenant" : { "id" : "-1", "creator" : "xdmAdmin", "createTime" : "2023-12-01T01:25:21.000+0000", "modifier" : "xdmAdmin", "lastUpdateTime" : "2023-12-01T01:25:21.000+0000", "rdmExtensionType" : "Tenant", "tenant" : null, "className" : "Tenant", "name" : "basicTenant", "description" : "默认租户", "code" : "basicTenant", "disableFlag" : false, "dataSource" : "DefaultDataSource" }, "className" : "TreeableModel" } ], "errors" : [ ] }
  • 请求示例 POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/TreeableModel/getAllParentList { "params" : { "childId" : "616949021809840128" } }
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 result String 参数解释: 请求结果。 取值范围: SUCCESS:请求成功。 FAIL:请求失败。 默认取值: 不涉及。 data Array of BasicObjectQueryViewDTO objects 参数解释: 请求数据。 取值范围: 不涉及。 默认取值: 不涉及。 errors Array of strings 参数解释: 异常信息。 取值范围: 不涉及。 默认取值: 不涉及。 pageInfo PageInfoViewDTO object 参数解释: 分页信息。 取值范围: 不涉及。 默认取值: 不涉及。 表6 BasicObjectQueryViewDTO 参数 参数类型 描述 id String 参数解释: 唯一标识。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。 creator String 参数解释: 创建者。 取值范围: 不涉及。 默认取值: 不涉及。 createTime String 参数解释: 创建时间。 取值范围: 不涉及。 默认取值: 不涉及。 modifier String 参数解释: 修改人。 取值范围: 不涉及。 默认取值: 不涉及。 lastUpdateTime String 参数解释: 最后的修改时间。 取值范围: 不涉及。 默认取值: 不涉及。 rdmExtensionType String 参数解释: 扩展类型。 取值范围: 不涉及。 默认取值: 不涉及。 tenant TenantViewDTO object 参数解释: 租户信息。 取值范围: 不涉及。 默认取值: 不涉及。 className String 参数解释: 类名。 取值范围: 不涉及。 默认取值: 不涉及。 表7 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 参数解释: 租户信息。 取值范围: 不涉及。 默认取值: 不涉及。 表8 PageInfoViewDTO 参数 参数类型 描述 curPage Integer 参数解释: 当前页。 取值范围: 不涉及。 默认取值: 不涉及。 pageSize Integer 参数解释: 每页大小。 取值范围: 不涉及。 默认取值: 不涉及。 totalRows Integer 参数解释: 总行数。 取值范围: 不涉及。 默认取值: 不涉及。 totalPages Integer 参数解释: 总页数。 取值范围: 不涉及。 默认取值: 不涉及。
  • URI POST /rdm_{identifier}_app/publicservices/api/{modelName}/getAllParentList 表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 否 QueryParentDTO object 参数解释: 请求参数对象。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 表4 QueryParentDTO 参数 是否必选 参数类型 描述 childId 是 String 参数解释: 子节点实例ID。 约束限制: 不涉及。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。
  • 操作步骤 获取接口相关信息。 URI格式:POST /wom/v1/wo-schemes/batch-generate 详情请参见批量生成工单方案。 在Request Header中增加“X-Auth-Token”。 发送“POST https://{iDME Endpoint}/wom/v1/wo-schemes/batch-generate”。 Body [ "1417639245421830258", "1425789631742573107" ] 查看请求响应结果。 请求成功时,响应参数如下: { "status" : "200", "message" : "success", "data" : 1 } 请求异常时,错误码请参见错误码。
  • 前提条件 已开通工业数字模型驱动引擎(Industrial Digital Model Engine,简称iDME)/数字化制造基础服务,并根据开通区域确定调用API的Endpoint,详细信息请参见地区与终端节点。 当您使用Token认证方式完成认证鉴权时,需要获取用户Token并在调用接口时增加“X-Auth-Token”到业务接口请求消息头中。Token认证,具体操作请参考认证鉴权。 通过IAM服务获取到的Token有效期为24小时,需要使用同一个Token鉴权时,可以先将Token缓存,避免频繁调用。
共100000条