华为云用户手册

  • URI POST /rdm_{identifier}_app/publicservices/api/{modelName}/find/{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。
  • 响应示例 状态码: 200 请求成功 { "status" : "200", "message" : "success", "data" : 1 } 状态码: 400 参数校验异常 { "error_code" : " IDT .06031001", "error_msg" : "{0} is required and cannot be empty." } 状态码: 500 API执行异常 { "status" : "500", "message" : "API执行异常", "data" : null }
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 status String 响应状态 message String 响应信息 data Object 返回结果 状态码: 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误代码 error_msg String 错误信息 状态码: 500 表4 响应Body参数 参数 参数类型 描述 status String 响应状态 message String 响应信息 data Object 返回结果
  • 响应示例 状态码: 200 OK { "result" : "SUC CES S", "data" : [ { "id" : "610123340111159296", "creator" : "test1", "modifier" : "test1", "createTime" : "2024-02-19T06:38:10.406+0000", "lastUpdateTime" : "2024-02-19T06:56:43.319+0000", "rdmVersion" : 1, "rdmDeleteFlag" : 0, "rdmExtensionType" : "MultiViewModel", "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" : "MultiViewModel", "name" : "多视图管理", "description" : "多视图管理", "kiaguid" : "18409de0386546f8af4bb6c1dc5cf50f", "securityLevel" : "internal", "master" : { "id" : "2", "creator" : "test1", "modifier" : "test1", "createTime" : "2024-02-19T06:38:10.419+0000", "lastUpdateTime" : "2024-02-19T06:56:43.319+0000", "rdmVersion" : 1, "rdmDeleteFlag" : 0, "rdmExtensionType" : "MultiViewModelMaster", "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" : "MultiViewModelMaster" }, "branch" : { "id" : "601060080799981568", "creator" : "test1", "modifier" : "test1", "createTime" : "2024-02-19T06:38:10.464+0000", "lastUpdateTime" : "2024-02-19T06:56:43.319+0000", "rdmVersion" : 1, "rdmDeleteFlag" : 0, "rdmExtensionType" : "MultiViewModelBranch", "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" : "MultiViewModelBranch", "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" : 1, "item" : { "id" : "1", "creator" : "test1", "modifier" : "test1", "createTime" : "2024-02-19T06:38:10.464+0000", "lastUpdateTime" : "2024-02-19T06:56:43.319+0000", "rdmVersion" : 1, "rdmDeleteFlag" : 0, "rdmExtensionType" : "MultiViewItem", "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" : "MultiViewItem" } } ], "errors" : [ ] }
  • 请求示例 POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/MultiViewModel/batchCreateView { "applicationId" : "b3f9b7523a6141f4b2d76b92d6595281", "params" : [ { "versionId" : "1", "modifier" : "test1", "item" : { "id" : "1", "clazz" : "MultiViewItem" } } ] }
  • 响应参数 状态码: 200 表6 响应Body参数 参数 参数类型 描述 result String 参数解释: 请求结果。 取值范围: SUCCESS:请求成功。 FAIL:请求失败。 默认取值: 不涉及。 data Array of MultiViewModelViewDTO objects 参数解释: 请求数据。 取值范围: 不涉及。 默认取值: 不涉及。 errors Array of strings 参数解释: 异常信息。 取值范围: 不涉及。 默认取值: 不涉及。 表7 MultiViewModelViewDTO 参数 参数类型 描述 branch MultiViewModelBranchViewDTO 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:不是最新迭代版本。 默认取值: false。 latestVersion Boolean 参数解释: 是否为最新修订版本。 取值范围: true:是最新修订版本。 false:不是最新修订版本。 默认取值: false。 master MultiViewModelMasterViewDTO object 参数解释: 主对象。 取值范围: 不涉及。 默认取值: 不涉及。 modifier String 参数解释: 修改人。 取值范围: 不涉及。 默认取值: 不涉及。 name String 参数解释: 中文名称。 取值范围: 不涉及。 默认取值: 不涉及。 preVersionId String 参数解释: 前序版本实例ID。 取值范围: 不涉及。 默认取值: 不涉及。 rdmDeleteFlag Integer 参数解释: 软删除标识,参数值为0或1。 取值范围: 0:表示未删除。 1:表示已删除。 默认取值: 不涉及。 rdmExtensionType String 参数解释: 扩展类型。 取值范围: 不涉及。 默认取值: 不涉及。 rdmVersion Integer 参数解释: 系统版本。 取值范围: 不涉及。 默认取值: 不涉及。 securityLevel String 参数解释: 安全密级。 取值范围: INTERNAL:内部公开。 SECRET:秘密。 CONFIDENTIAL:机密。 TOP_SECRET:绝密。 默认取值: 不涉及。 tenant TenantViewDTO object 参数解释: 租户信息。 取值范围: 不涉及。 默认取值: 不涉及。 version String 参数解释: 版本号。 取值范围: 不涉及。 默认取值: 不涉及。 versionCode Integer 参数解释: 业务版本内码。 取值范围: 不涉及。 默认取值: 不涉及。 workingCopy Boolean 参数解释: 是否已检出。 取值范围: true:已检出。 false:未检出。 默认取值: 不涉及。 workingState WorkingState object 参数解释: 工作状态。 取值范围: 不涉及。 默认取值: 不涉及。 item MultiViewItemViewDTO object 参数解释: 绑定的多视图对象。 取值范围: 不涉及。 默认取值: 不涉及。 表8 MultiViewModelBranchViewDTO 参数 参数类型 描述 className String 参数解释: 类名。 取值范围: 不涉及。 默认取值: 不涉及。 createTime String 参数解释: 创建时间。 取值范围: 不涉及。 默认取值: 不涉及。 creator String 参数解释: 创建者。 取值范围: 不涉及。 默认取值: 不涉及。 id String 参数解释: 唯一标识。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。 lastUpdateTime String 参数解释: 最后更新时间。 取值范围: 不涉及。 默认取值: 不涉及。 modifier String 参数解释: 修改人。 取值范围: 不涉及。 默认取值: 不涉及。 rdmDeleteFlag Integer 参数解释: 软删除标识,参数值为0或1。 取值范围: 0:表示未删除。 1:表示已删除。 默认取值: 不涉及。 rdmExtensionType String 参数解释: 扩展类型。 取值范围: 不涉及。 默认取值: 不涉及。 rdmVersion Integer 参数解释: 系统版本。 取值范围: 不涉及。 默认取值: 不涉及。 tenant TenantViewDTO object 参数解释: 租户信息。 取值范围: 不涉及。 默认取值: 不涉及。 version String 参数解释: 版本号。 取值范围: 不涉及。 默认取值: 不涉及。 表9 MultiViewModelMasterViewDTO 参数 参数类型 描述 className String 参数解释: 类名。 取值范围: 不涉及。 默认取值: 不涉及。 createTime String 参数解释: 创建时间。 取值范围: 不涉及。 默认取值: 不涉及。 creator String 参数解释: 创建者。 取值范围: 不涉及。 默认取值: 不涉及。 id String 参数解释: 唯一标识。 约束限制: 不涉及。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。 lastUpdateTime String 参数解释: 最后更新时间。 取值范围: 不涉及。 默认取值: 不涉及。 modifier String 参数解释: 修改人。 取值范围: 不涉及。 默认取值: 不涉及。 rdmDeleteFlag Integer 参数解释: 软删除标识,参数值为0或1。 取值范围: 0:表示未删除。 1:表示已删除。 默认取值: 不涉及。 rdmExtensionType String 参数解释: 扩展类型。 取值范围: 不涉及。 默认取值: 不涉及。 rdmVersion Integer 参数解释: 系统版本。 取值范围: 不涉及。 默认取值: 不涉及。 tenant TenantViewDTO object 参数解释: 租户信息。 取值范围: 不涉及。 默认取值: 不涉及。 表10 WorkingState 参数 参数类型 描述 alias String 参数解释: 别名。 取值范围: 不涉及。 默认取值: 不涉及。 cnName String 参数解释: 中文名称。 取值范围: 不涉及。 默认取值: 不涉及。 code String 参数解释: 编码。 取值范围: 不涉及。 默认取值: 不涉及。 enName String 参数解释: 英文名称。 取值范围: 不涉及。 默认取值: 不涉及。 表11 MultiViewItemViewDTO 参数 参数类型 描述 className String 参数解释: 类名。 取值范围: 不涉及。 默认取值: 不涉及。 createTime String 参数解释: 创建时间。 取值范围: 不涉及。 默认取值: 不涉及。 creator String 参数解释: 创建者。 取值范围: 不涉及。 默认取值: 不涉及。 id String 参数解释: 唯一标识。 约束限制: 不涉及。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。 rdmDeleteFlag Integer 参数解释: 软删除标识,参数值为0或1。 取值范围: 0:表示未删除。 1:表示已删除。 默认取值: 不涉及。 rdmExtensionType String 参数解释: 扩展类型。 取值范围: 不涉及。 默认取值: 不涉及。 rdmVersion Integer 参数解释: 系统版本。 取值范围: 不涉及。 默认取值: 不涉及。 modifier String 参数解释: 修改人。 取值范围: 不涉及。 默认取值: 不涉及。 lastUpdateTime Object 参数解释: 最后更新时间。 取值范围: 不涉及。 默认取值: 不涉及。 tenant TenantViewDTO object 参数解释: 租户信息。 取值范围: 不涉及。 默认取值: 不涉及。 表12 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 参数解释: 租户信息。 取值范围: 不涉及。 默认取值: 不涉及。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释: IAM 用户的token。 获取方法请参见获取IAM用户Token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 params 否 Array of MultiViewModelVersionViewCreateDTO objects 参数解释: 请求参数对象。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 applicationId 否 String 参数解释: 应用ID。 约束限制: 不涉及。 取值范围: 由英文字母和数字组成,且长度为32个字符。 默认取值: 不涉及。 表4 MultiViewModelVersionViewCreateDTO 参数 是否必选 参数类型 描述 modifier 否 String 参数解释: 修改人。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 versionId 是 String 参数解释: 版本对象ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 workCopyType 否 String 参数解释: 关系的复制类型。 约束限制: 不涉及。 取值范围: BOTH:若存在关系实例引用此 数据实例 作为源端实例或目标端实例,创建多维版本后的数据实例将继承这些关系实例。 SOURCE:若存在关系实例引用此数据实例作为源端实例,创建多维版本后的数据实例将继承这些关系实例。 TARGET:若存在关系实例引用此数据实例作为目标端实例,创建多维版本后的数据实例将继承这些关系实例。 NONE:创建多维版本后的数据实例将不继承任何关系实例。 CUSTOM:若指定的关系实体集合对应的关系实例引用此数据实例作为源端实例或目标端实例,创建多维版本后的数据实例将继承这些关系实例。 默认取值: 不涉及。 customLinkSet 否 Array of strings 参数解释: 关系实体名称集合,与workCopyType的值CUSTOM配合使用。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 needSetNull 否 Array of strings 参数解释: 指定不复制的属性,其值将被设置为null。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 item 是 ObjectReferenceParamDTO object 参数解释: 引用对象。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 表5 ObjectReferenceParamDTO 参数 是否必选 参数类型 描述 clazz 否 String 参数解释: 类名。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 id 是 String 参数解释: 数据实例ID。 约束限制: 不涉及。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。
  • URI POST /rdm_{identifier}_app/publicservices/api/{modelName}/batchCreateView 表1 路径参数 参数 是否必选 参数类型 描述 identifier 是 String 参数解释: 应用唯一标识。 约束限制: 不涉及。 取值范围: 由英文字母和数字组成,且长度为32个字符。 默认取值: 不涉及。 modelName 是 String 参数解释: 数据模型的英文名称。 约束限制: 不涉及。 取值范围: 大写字母开头,只能包含字母、数字、"_",且长度为[1-60]个字符。 默认取值: 不涉及。
  • 响应示例 状态码: 200 请求成功 { "status" : "200", "message" : "success", "data" : [ { "wo_id" : "1574698325467510369", "wo_order" : "WOP123456", "erp_wo_id" : "1457698771257845", "erp_wo_order" : "QWERTYUI", "parent_wo_id" : "1478932452572618", "parent_wo_order" : "WOP147369", "wo_type" : "10", "part_id" : "1564789221484123", "part_no" : "TEST2023", "part_desc" : "MODEL测试", "part_revision" : "1", "lot_unit" : 1, "wo_qty" : 100, "site_id" : "22DF4572394G485KF502", "site_no" : "TEST210213", "completed_qty" : 1, "wo_status" : "10", "hold_flag" : "0", "split_flag" : "1", "solution_flag" : "2", "sn_generate_flag" : "0", "erp_plan_start_date" : "2023-08-14 00:00:00", "erp_plan_end_date" : "2023-08-14 00:00:00", "data_source" : "MANUAL", "actual_wo_start_date" : "2023-08-14 00:00:00", "actual_wo_complete_date" : "2023-08-14 00:00:00", "org_id" : "1" } ] } 状态码: 400 参数校验异常 { "error_code" : "IDT.0604xxxx", "error_msg" : "xxx does not exist" } 状态码: 500 API执行异常 { "error_code" : "IDT.0604xxxx", "error_msg" : "xxx does not exist" }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 [数组元素] Array of OpenWoInfo objects 请求成功 表4 OpenWoInfo 参数 参数类型 描述 wo_id String 工单ID wo_order String 工单号 erp_wo_id String ERP工单ID erp_wo_order String ERP工单号 parent_wo_id String 父项工单ID parent_wo_order String 父项工单号 wo_type String 工单类型 10:生产工单 20:返工工单 30:预加工工单 part_id String 产品编码ID part_no String 产品编码 part_desc String 产品描述 part_revision String 版本 lot_unit Integer 产品单LOT批量 wo_qty Integer 工单批量 site_id String 加工区域ID site_no String 加工区域代码 completed_qty Integer 完工数量 wo_status String 工单状态 10:初始化 20:已排产 30:已下发 40:开始生产 50:工单完工 60:工单关闭 10000:已取消 hold_flag String 冻结标识(默认为0) 0:正常 1:冻结 split_flag String 预加工单拆分标识(默认为0) 0:初始化 1:拆分成功 2:拆分失败 solution_flag String 工单方案生成标识(默认为0) 0:初始化 1:生成成功 2:生成失败 3:实例化成功 4:实例化失败 8:生成中 9:实例化中 sn_generate_flag String SN展开标识(默认为0) 0:初始化 1:生成成功 2:生成失败 erp_plan_start_date String ERP计划开工时间 erp_plan_end_date String ERP计划完工时间 data_source String 数据来源 actual_wo_start_date String 工单实际开工时间 actual_wo_complete_date String 工单实际完工时间 org_id String 组织号ID 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误代码 error_msg String 错误信息 状态码: 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误代码 error_msg String 错误信息
  • 前提条件 已开通工业数字模型驱动引擎(Industrial Digital Model Engine,简称iDME)/数字化制造基础服务,并根据开通区域确定调用API的Endpoint,详细信息请参见地区与终端节点。 当您使用Token认证方式完成认证鉴权时,需要获取用户Token并在调用接口时增加“X-Auth-Token”到业务接口请求消息头中。Token认证,具体操作请参考认证鉴权。 通过IAM服务获取到的Token有效期为24小时,需要使用同一个Token鉴权时,可以先将Token缓存,避免频繁调用。
  • 操作步骤 获取接口相关信息。 URI格式:POST /wom/v1/wos/wo-info 详情请参见按工单获取工单相关信息。 在Request Header中增加“X-Auth-Token”。 发送“POST https://{iDME Endpoint}/wom/v1/wos/wo-info”。 Body [ { "wo_id" : "1574698325467510369", "wo_order" : "WOP123456" } ] 查看请求响应结果。 请求成功时,响应参数如下: { "status" : "200", "message" : "success", "data" : [ { "wo_id" : "1574698325467510369", "wo_order" : "WOP123456", "erp_wo_id" : "1457698771257845", "erp_wo_order" : "QWERTYUI", "parent_wo_id" : "1478932452572618", "parent_wo_order" : "WOP147369", "wo_type" : "10", "part_id" : "1564789221484123", "part_no" : "TEST2023", "part_desc" : "MODEL测试", "part_revision" : "1", "lot_unit" : 1, "wo_qty" : 100, "site_id" : "22DF4572394G485KF502", "site_no" : "TEST210213", "completed_qty" : 1, "wo_status" : "10", "hold_flag" : "0", "split_flag" : "1", "solution_flag" : "2", "sn_generate_flag" : "0", "erp_plan_start_date" : "2023-08-14 00:00:00", "erp_plan_end_date" : "2023-08-14 00:00:00", "data_source" : "MANUAL", "actual_wo_start_date" : "2023-08-14 00:00:00", "actual_wo_complete_date" : "2023-08-14 00:00:00", "org_id" : "1" } ] } 请求异常时,错误码请参见错误码。
  • 响应示例 状态码: 200 OK { "result" : "SUCCESS", "data" : [ { "id" : "65465412", "creator" : "test1", "modifier" : "XDM_Developer xxx", "createTime" : "2023-12-06T09:15:29.556+0000", "lastUpdateTime" : "2023-12-06T09:15:29.556+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 }, { "id" : "65465432", "creator" : "test1", "modifier" : "XDM_Developer xxx", "createTime" : "2023-12-06T09:15:29.556+0000", "lastUpdateTime" : "2023-12-06T09:15:29.556+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" : [ ] }
  • 请求示例 POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/PersistableModel/batchCreate { "applicationId" : "b3f9b7523a6141f4b2d76b92d6595281", "params" : [ { "id" : "777", "tenant" : { "id" : "-1", "clazz" : "Tenant" }, "rdmExtensionType" : "PersistableModel", "creator" : "test1", "modifier" : "test1", "uniqueKey" : "union key new create 2" }, { "id" : "888", "tenant" : { "id" : "-1", "clazz" : "Tenant" }, "rdmExtensionType" : "PersistableModel", "creator" : "test1", "modifier" : "test1", "uniqueKey" : "union key new create 3" } ] }
  • 响应参数 状态码: 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 参数解释: 租户信息。 取值范围: 不涉及。 默认取值: 不涉及。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释: IAM用户的token。 获取方法请参见获取IAM用户Token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 applicationId 否 String 参数解释: 应用ID。 约束限制: 不涉及。 取值范围: 由英文字母和数字组成,且长度为32个字符。 默认取值: 不涉及。 params 否 Array of PersistableModelCreateDTO objects 参数解释: 请求参数对象。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 表4 PersistableModelCreateDTO 参数 是否必选 参数类型 描述 createTime 否 String 参数解释: 创建时间。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 creator 否 String 参数解释: 创建者。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 id 否 String 参数解释: 唯一标识。 约束限制: 不涉及。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。 lastUpdateTime 否 String 参数解释: 最后更新时间。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 modifier 否 String 参数解释: 修改人。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 rdmExtensionType 否 String 参数解释: 扩展类型。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 tenant 否 ObjectReferenceParamDTO object 参数解释: 租户信息。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 uniqueKey 否 String 参数解释: 示例模型的唯一键属性。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 表5 ObjectReferenceParamDTO 参数 是否必选 参数类型 描述 clazz 否 String 参数解释: 类名。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 id 是 String 参数解释: 数据实例ID。 约束限制: 不涉及。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。
  • URI POST /rdm_{identifier}_app/publicservices/api/{modelName}/batchCreate 表1 路径参数 参数 是否必选 参数类型 描述 identifier 是 String 参数解释: 应用唯一标识。 约束限制: 不涉及。 取值范围: 由英文字母和数字组成,且长度为32个字符。 默认取值: 不涉及。 modelName 是 String 参数解释: 数据模型的英文名称。 约束限制: 不涉及。 取值范围: 大写字母开头,只能包含字母、数字、"_",且长度为[1-60]个字符。 默认取值: 不涉及。
  • 响应示例 状态码: 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" : "INWORK", "cnName" : "工作中", "enName" : "inwork", "alias" : "INWORK" }, "checkOutUserName" : "Zhaoliu", "checkOutTime" : "2024-02-20T03:20:17.843+0000", "preVersionId" : "601372141664866304" } ], "errors" : [ ] }
  • 请求示例 POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/VersionModel/checkout { "applicationId" : "b3f9b7523a6141f4b2d76b92d6595281", "params" : { "masterId" : "602146893727801345", "modifier" : "test1", "workCopyType" : "BOTH", "creator" : "test1", "customLinkSet" : [ ] } }
  • 响应参数 状态码: 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 参数解释: 英文名称。 取值范围: 不涉及。 默认取值: 不涉及。
  • URI POST /rdm_{identifier}_app/publicservices/api/{modelName}/checkout 表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 否 VersionModelVersionCheckOutDTO object 参数解释: 请求参数对象。 取值范围: 不涉及。 默认取值: 不涉及。 表4 VersionModelVersionCheckOutDTO 参数 是否必选 参数类型 描述 creator 否 String 参数解释: 创建人。 取值范围: 不涉及。 默认取值: 不涉及。 customLinkSet 否 Array of strings 参数解释: 关系实体名称集合,与workCopyType的值CUSTOM配合使用。 取值范围: 不涉及。 默认取值: 不涉及。 masterId 是 String 参数解释: 主对象ID。 取值范围: 不涉及。 默认取值: 不涉及。 modifier 否 String 参数解释: 更新者。 取值范围: 不涉及。 默认取值: 不涉及。 workCopyType 否 String 参数解释: 关系的复制类型。 取值范围: BOTH:若存在关系实例引用此数据实例作为源端实例或目标端实例,检出后的数据实例将继承这些关系实例。 SOURCE:若存在关系实例引用此数据实例作为源端实例,检出后的数据实例将继承这些关系实例。 TARGET:若存在关系实例引用此数据实例作为目标端实例,检出后的数据实例将继承这些关系实例。 NONE:检出后的数据实例将不继承任何关系实例。 CUSTOM:若指定的关系实体集合对应的关系实例引用此数据实例作为源端实例或目标端实例,检出后的数据实例将继承这些关系实例。 默认取值: 不涉及。
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 result String 参数解释: 请求结果。 取值范围: SUCCESS:请求成功。 FAIL:请求失败。 默认取值: 不涉及。 data Array of longs 参数解释: 请求操作数据数量。 取值范围: 不涉及。 默认取值: 不涉及。 errors Array of strings 参数解释: 异常信息。 取值范围: 不涉及。 默认取值: 不涉及。
  • URI POST /rdm_{identifier}_app/publicservices/api/{modelName}/logicalDelete 表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 否 PersistObjectIdModifierDTO object 参数解释: 请求参数对象。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 表4 PersistObjectIdModifierDTO 参数 是否必选 参数类型 描述 id 是 String 参数解释: 唯一标识。 约束限制: 不涉及。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。 modifier 否 String 参数解释: 请求参数对象。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。
  • 请求示例 POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/PersistableModel/logicalDelete { "applicationId" : "b3f9b7523a6141f4b2d76b92d6595281", "params" : { "id" : "777", "modifier" : "test1" } }
  • 支持的授权项 策略包含系统策略和自定义策略,如果系统策略不满足授权要求,管理员可以创建自定义策略,并通过给用户组授予自定义策略来进行精细的访问控制。策略支持的操作与API相对应,授权项列表说明如下: 权限:允许或拒绝在特定条件下对制定资源进行某项操作。 对应API接口:自定义策略实际调用的API接口。 授权项:自定义策略中支持的Action,在自定义策略中的Action中写入授权项,可以实现授权项对应的权限功能。 依赖的授权项:部分Action存在对其他Action的依赖,需要将依赖的Action同时写入授权项,才能实现对应的权限功能。 IAM项目(Project)/企业项目(Enterprise Project):自定义策略的授权范围,包括IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目,表示此授权项对应的自定义策略,可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目,不支持企业项目,表示仅能在IAM中给用户组授权并生效,如果在企业管理中授权,则该自定义策略不生效。关于IAM项目与企业项目的区别,详情请参见:IAM与企业管理的区别。 “√”表示支持,“x”表示暂不支持。 iDME的支持自定义策略授权项如下所示: 表1 控制台的细化权限说明 权限 对应API接口 授权项(Action) IAM项目 (Project) 企业项目 (Enterprise Project) 创建应用 /v1/{project_id}/apps dme:apps:create √ × 获取租户下的应用清单 /v1/{project_id}/apps dme:apps:get √ × 编辑应用 /v1/{project_id}/apps/{app_id} dme:apps:modify √ × 获取运行服务清单 /v1/{project_id}/envs dme:envs:get √ × 部署应用 /v1/{project_id}/envs/{env_id}/apps/{app_id}/deploy dme:envs:deployApp √ × 卸载应用 /v1/{project_id}/envs/{env_id}/apps/{app_id} dme:envs:destroyApp √ × 删除应用 /v1/{project_id}/apps/{app_id} dme:apps:delete √ ×
  • 请求示例 POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/PersistableModel/get { "applicationId" : "b3f9b7523a6141f4b2d76b92d6595281", "params" : { "decrypt" : false, "id" : "1" } }
  • 响应示例 状态码: 200 OK { "result" : "SUCCESS", "data" : [ { "id" : "789", "creator" : "AAA", "modifier" : "xdmAdmin ", "createTime" : "2023-12-04T12:47:29.000+0000", "lastUpdateTime" : "2023-12-04T12:47:29.000+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参数 参数 是否必选 参数类型 描述 applicationId 否 String 参数解释: 应用ID。 约束限制: 不涉及。 取值范围: 由英文字母和数字组成,且长度为32个字符。 默认取值: 不涉及。 params 否 PersistObjectIdDecryptDTO object 参数解释: 请求参数对象。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 表4 PersistObjectIdDecryptDTO 参数 是否必选 参数类型 描述 decrypt 否 Boolean 参数解释: 是否加密。 约束限制: 不涉及。 取值范围: true:加密。 false:不加密。 默认取值: false。 id 是 String 参数解释: 唯一标识。 约束限制: 不涉及。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。
共100000条