华为云用户手册

  • 请求参数 表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" : "SUC CES S", "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缓存,避免频繁调用。
  • 响应示例 状态码: 200 OK { "result" : "SUCCESS", "data" : [ { "id" : "616949021809840128", "creator" : "xdmAdmin", "createTime" : "2024-04-03T02:55:09.158+0000", "modifier" : "xdmAdmin", "lastUpdateTime" : "2024-04-03T02:55:09.158+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" : [ ], "pageInfo" : { "curPage" : 1, "pageSize" : 10, "totalRows" : 1, "totalPages" : 1 } }
  • 请求示例 POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/TreeableModel/getChildList/10/1 { "params" : { "parentId" : "616948972547739648" } }
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释: IAM用户的token。 获取方法请参见获取IAM用户Token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 表4 请求Body参数 参数 是否必选 参数类型 描述 applicationId 否 String 参数解释: 应用ID。 约束限制: 不涉及。 取值范围: 由英文字母和数字组成,且长度为32个字符。 默认取值: 不涉及。 params 否 QueryChildListDTO object 参数解释: 请求参数对象。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 表5 QueryChildListDTO 参数 是否必选 参数类型 描述 parentId 否 String 参数解释: 父节点实例ID。 约束限制: 不涉及。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。
  • URI POST /rdm_{identifier}_app/publicservices/api/{modelName}/getChildList/{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 表6 响应Body参数 参数 参数类型 描述 result String 参数解释: 请求结果。 取值范围: SUCCESS:请求成功。 FAIL:请求失败。 默认取值: 不涉及。 data Array of BasicObjectQueryViewDTO objects 参数解释: 请求数据。 取值范围: 不涉及。 默认取值: 不涉及。 errors Array of strings 参数解释: 异常信息。 取值范围: 不涉及。 默认取值: 不涉及。 pageInfo PageInfoViewDTO object 参数解释: 分页信息。 取值范围: 不涉及。 默认取值: 不涉及。 表7 BasicObjectQueryViewDTO 参数 参数类型 描述 id String 参数解释: 唯一标识。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。 creator String 参数解释: 创建者。 取值范围: 不涉及。 默认取值: 不涉及。 createTime String 参数解释: 创建时间。 取值范围: 不涉及。 默认取值: 不涉及。 modifier String 参数解释: 修改人。 取值范围: 不涉及。 默认取值: 不涉及。 lastUpdateTime String 参数解释: 最后的修改时间。 取值范围: 不涉及。 默认取值: 不涉及。 rdmExtensionType String 参数解释: 扩展类型。 取值范围: 不涉及。 默认取值: 不涉及。 tenant TenantViewDTO object 参数解释: 租户信息。 取值范围: 不涉及。 默认取值: 不涉及。 className 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 参数解释: 租户信息。 取值范围: 不涉及。 默认取值: 不涉及。 表9 PageInfoViewDTO 参数 参数类型 描述 curPage Integer 参数解释: 当前页。 取值范围: 不涉及。 默认取值: 不涉及。 pageSize Integer 参数解释: 每页大小。 取值范围: 不涉及。 默认取值: 不涉及。 totalRows Integer 参数解释: 总行数。 取值范围: 不涉及。 默认取值: 不涉及。 totalPages Integer 参数解释: 总页数。 取值范围: 不涉及。 默认取值: 不涉及。
  • 获取账号ID 在调用接口的时候,部分URL中需要填入账号ID,所以需要先在管理控制台上获取到账号ID。账号ID获取步骤如下: 登录华为云控制台。 将鼠标移动到页面右上角的账号名,在下拉列表中单击“我的凭证”,进入“我的凭证”页面。 在左侧导航栏中,单击“API凭证”,进入“API凭证”页面。 您可以在该页面查看IAM用户名(user name)、IAM用户ID(user_id)、账号名(domain name)、账号ID(domain_id)等信息。 图1 获取账号ID 父主题: 附录
  • 请求示例 POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/RelationModel/queryRelationship/10/1 { "params" : { "role" : "Target", "objectId" : "614786496192323584", "isNeedTotal" : true, "latestOnly" : false } }
  • 响应示例 状态码: 200 OK { "result" : "SUCCESS", "data" : [ { "id" : "614786585191260160", "creator" : "xdmAdmin", "modifier" : "xdmAdmin", "createTime" : "2024-03-28T03:42:24.092+0000", "lastUpdateTime" : "2024-03-28T03:42:24.092+0000", "rdmVersion" : 1, "rdmDeleteFlag" : 0, "rdmExtensionType" : "RelationModel", "tenant" : { "id" : "-1", "creator" : "xdmAdmin", "modifier" : "xdmAdmin", "createTime" : "2024-03-28T03:28:34.795+0000", "lastUpdateTime" : "2024-03-28T03:28:34.795+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" : "RelationModel", "source" : { "id" : "614786412419489792", "creator" : "xdmAdmin", "modifier" : "xdmAdmin", "createTime" : "2024-03-28T03:41:42.900+0000", "lastUpdateTime" : "2024-03-28T03:41:42.900+0000", "rdmVersion" : 1, "rdmDeleteFlag" : 0, "rdmExtensionType" : "Classes", "tenant" : { "id" : "-1", "creator" : "xdmAdmin", "modifier" : "xdmAdmin", "createTime" : "2024-03-28T03:28:34.795+0000", "lastUpdateTime" : "2024-03-28T03:28:34.795+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" : "Classes", "name" : "初二四班", "description" : "初中二年级四班", "kiaguid" : null, "securityLevel" : "internal" }, "target" : { "id" : "614786496192323584", "creator" : "xdmAdmin", "modifier" : "xdmAdmin", "createTime" : "2024-03-28T03:42:02.873+0000", "lastUpdateTime" : "2024-03-28T03:42:02.873+0000", "rdmVersion" : 1, "rdmDeleteFlag" : 0, "rdmExtensionType" : "Student", "tenant" : { "id" : "-1", "creator" : "xdmAdmin", "modifier" : "xdmAdmin", "createTime" : "2024-03-28T03:28:34.795+0000", "lastUpdateTime" : "2024-03-28T03:28:34.795+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" : "Student", "name" : "张三", "description" : null, "kiaguid" : null, "securityLevel" : "internal", "grade" : "98.99" }, "name" : null, "description" : null } ], "errors" : [ ], "pageInfo" : { "curPage" : 1, "pageSize" : 1000, "totalRows" : 1, "totalPages" : 1 } }
  • 响应参数 状态码: 200 表6 响应Body参数 参数 参数类型 描述 result String 参数解释: 请求结果。 取值范围: SUCCESS:请求成功。 FAIL:请求失败。 默认取值: 不涉及。 data Array of RelationModelViewDTO objects 参数解释: 请求数据。 取值范围: 不涉及。 默认取值: 不涉及。 errors Array of strings 参数解释: 异常信息。 取值范围: 不涉及。 默认取值: 不涉及。 pageInfo PageInfoViewDTO object 参数解释: 分页信息。 取值范围: 不涉及。 默认取值: 不涉及。 表7 RelationModelViewDTO 参数 参数类型 描述 className String 参数解释: 类名。 取值范围: 不涉及。 默认取值: 不涉及。 createTime String 参数解释: 创建时间。 取值范围: 不涉及。 默认取值: 不涉及。 creator String 参数解释: 创建者。 取值范围: 不涉及。 默认取值: 不涉及。 description String 参数解释: 实体描述。 取值范围: 不涉及。 默认取值: 不涉及。 id String 参数解释: 唯一标识。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。 lastUpdateTime String 参数解释: 最后更新时间。 取值范围: 不涉及。 默认取值: 不涉及。 modifier String 参数解释: 修改人。 取值范围: 不涉及。 默认取值: 不涉及。 name String 参数解释: 名称。 取值范围: 不涉及。 默认取值: 不涉及。 rdmDeleteFlag Integer 参数解释: 软删除标识,参数值为0或1。 取值范围: 0:表示未删除。 1:表示已删除。 默认取值: 不涉及。 rdmExtensionType String 参数解释: 扩展类型。 取值范围: 不涉及。 默认取值: 不涉及。 rdmVersion Integer 参数解释: 系统版本。 取值范围: 不涉及。 默认取值: 不涉及。 source ClassesViewDTO object 参数解释: 源实体。 取值范围: 不涉及。 默认取值: 不涉及。 target StudentViewDTO object 参数解释: 目标实体。 取值范围: 不涉及。 默认取值: 不涉及。 tenant TenantViewDTO object 参数解释: 租户信息。 取值范围: 不涉及。 默认取值: 不涉及。 表8 ClassesViewDTO 参数 参数类型 描述 className String 参数解释: 类名。 取值范围: 不涉及。 默认取值: 不涉及。 createTime String 参数解释: 创建时间。 取值范围: 不涉及。 默认取值: 不涉及。 creator String 参数解释: 创建者。 取值范围: 不涉及。 默认取值: 不涉及。 description String 参数解释: 描述。 取值范围: 不涉及。 默认取值: 不涉及。 id String 参数解释: 唯一标识。 约束限制: 不涉及。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。 kiaguid String 参数解释: 关键信息资产ID。 取值范围: 不涉及。 默认取值: 不涉及。 lastUpdateTime String 参数解释: 最新更新时间。 取值范围: 不涉及。 默认取值: 不涉及。 modifier String 参数解释: 修改人。 取值范围: 不涉及。 默认取值: 不涉及。 name String 参数解释: 名称。 取值范围: 不涉及。 默认取值: 不涉及。 rdmDeleteFlag Integer 参数解释: 软删除标识,参数值为0或1。 取值范围: 0:表示未删除。 1:表示已删除。 默认取值: 不涉及。 rdmExtensionType String 参数解释: 扩展类型。 取值范围: 不涉及。 默认取值: 不涉及。 rdmVersion Integer 参数解释: 系统版本。 取值范围: 不涉及。 默认取值: 不涉及。 securityLevel String 参数解释: 安全密级。 取值范围: INTERNAL:内部公开。 SECRET:秘密。 CONFIDENTIAL:机密。 TOP_SECRET:绝密。 默认取值: 不涉及。 tenant TenantViewDTO object 参数解释: 租户信息。 取值范围: 不涉及。 默认取值: 不涉及。 表9 StudentViewDTO 参数 参数类型 描述 className String 参数解释: 类名。 取值范围: 不涉及。 默认取值: 不涉及。 createTime String 参数解释: 创建时间。 取值范围: 不涉及。 默认取值: 不涉及。 creator String 参数解释: 创建者。 取值范围: 不涉及。 默认取值: 不涉及。 description String 参数解释: 描述。 取值范围: 不涉及。 默认取值: 不涉及。 grade Number 参数解释: 成绩。 取值范围: 不涉及。 默认取值: 不涉及。 id String 参数解释: 唯一标识。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。 kiaguid String 参数解释: 关键信息资产ID。 取值范围: 不涉及。 默认取值: 不涉及。 lastUpdateTime String 参数解释: 最新更新时间。 取值范围: 不涉及。 默认取值: 不涉及。 modifier String 参数解释: 修改人。 取值范围: 不涉及。 默认取值: 不涉及。 name String 参数解释: 名称。 取值范围: 不涉及。 默认取值: 不涉及。 rdmDeleteFlag Integer 参数解释: 软删除标识,参数值为0或1。 取值范围: 0:表示未删除。 1:表示已删除。 默认取值: 不涉及。 rdmExtensionType String 参数解释: 扩展类型。 取值范围: 不涉及。 默认取值: 不涉及。 rdmVersion Integer 参数解释: 系统版本。 取值范围: 不涉及。 默认取值: 不涉及。 securityLevel String 参数解释: 安全密级。 取值范围: INTERNAL:内部公开。 SECRET:秘密。 CONFIDENTIAL:机密。 TOP_SECRET:绝密。 默认取值: 不涉及。 tenant TenantViewDTO object 参数解释: 租户信息。 取值范围: 不涉及。 默认取值: 不涉及。 表10 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 参数解释: 租户信息。 取值范围: 不涉及。 默认取值: 不涉及。 表11 PageInfoViewDTO 参数 参数类型 描述 curPage Integer 参数解释: 当前页。 取值范围: 不涉及。 默认取值: 不涉及。 pageSize Integer 参数解释: 每页大小。 取值范围: 不涉及。 默认取值: 不涉及。 totalRows Integer 参数解释: 总行数。 取值范围: 不涉及。 默认取值: 不涉及。 totalPages Integer 参数解释: 总页数。 取值范围: 不涉及。 默认取值: 不涉及。
  • URI POST /rdm_{identifier}_app/publicservices/api/{modelName}/queryRelationship/{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 否 GenericLinkQueryDTO object 参数解释: 请求参数对象。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 表5 GenericLinkQueryDTO 参数 是否必选 参数类型 描述 isNeedTotal 否 Boolean 参数解释: 是否需要查询总记录数。 约束限制: 不涉及。 取值范围: true:需要。 false:不需要。 默认取值: false。 latestOnly 否 Boolean 参数解释: 是否返回源模型 数据实例 关联的最新版本目标模型数据实例。此参数仅对源/目标模型为M-V模型实体有效。 约束限制: 不涉及。 取值范围: true:返回源模型数据实例关联的最新版本的目标模型数据实例。 false:返回源模型数据实例关联的所有版本的目标模型数据实例。默认为false。 默认取值: false。 objectId 否 String 参数解释: 角色对应数据实例ID。 约束限制: 不涉及。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。 role 否 String 参数解释: 角色。 约束限制: 不涉及。 取值范围: TARGET:目标模型。 SOURCE:源模型。 默认取值: 不涉及。
  • 响应示例 状态码: 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 返回结果
  • 请求示例 POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/PersistableModel/getByUniqueKey { "applicationId" : "b3f9b7523a6141f4b2d76b92d6595281", "params" : { "decrypt" : false, "uniqueKey" : "unionKey instance" } }
  • 响应示例 状态码: 200 OK { "result" : "SUCCESS", "data" : [ { "className" : "AircraftModel", "createTime" : "2023-09-27T06:18:03.000+0000", "creator" : "test1", "id" : "553535480021389300", "rdmDeleteFlag" : 1, "rdmExtensionType" : "AircraftModel", "rdmVersion" : 1, "modifier" : "test1", "lastUpdateTime" : "2023-09-27T06:18:03.000+0000", "tenant" : { "className" : "Tenant", "code" : "basicTenant", "createTime" : "2023-09-27T06:18:03.000+0000", "creator" : "test1", "dataSource" : "DefaultDataSource", "description" : "默认租户", "disableFlag" : false, "id" : -1, "kiaguid" : "string", "lastUpdateTime" : "2023-09-27T06:18:03.000+0000", "modifier" : "test1", "name" : "basicTenant", "rdmDeleteFlag" : 1, "rdmExtensionType" : "Tenant", "rdmVersion" : 1, "securityLevel" : "INTERNAL", "tenant" : "string" }, "uniqueKey" : "31415926548645664" } ], "errors" : [ ] }
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 result String 参数解释: 请求结果。 取值范围: SUCCESS:请求成功。 FAIL:请求失败。 默认取值: 不涉及。 data Array of PersistableModelViewDTO objects 请求数据。 errors Array of strings 参数解释: 异常信息。 取值范围: 不涉及。 默认取值: 不涉及。 表6 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 参数解释: 示例模型中定义的唯一键属性。 取值范围: 不涉及。 默认取值: 不涉及。 表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 参数解释: 租户信息。 取值范围: 不涉及。 默认取值: 不涉及。
  • URI POST /rdm_{identifier}_app/publicservices/api/{modelName}/{getUniqueFieldMethod} 表1 路径参数 参数 是否必选 参数类型 描述 identifier 是 String 参数解释: 应用唯一标识。 约束限制: 不涉及。 取值范围: 由英文字母和数字组成,且长度为32个字符。 默认取值: 不涉及。 modelName 是 String 参数解释: 数据模型的英文名称。 约束限制: 不涉及。 取值范围: 大写字母开头,只能包含字母、数字、"_",且长度为[1-60]个字符。 默认取值: 不涉及。 getUniqueFieldMethod 是 String 参数解释: 方法名称,格式为:getBy{uniqueName}。 uniqueName:表示“唯一键”为“是”的属性英文名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释: IAM用户的token。 获取方法请参见获取IAM用户Token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 applicationId 否 String 参数解释: 应用ID。 约束限制: 不涉及。 取值范围: 由英文字母和数字组成,且长度为32个字符。 默认取值: 不涉及。 params 否 PersistableModelUniqueKeyDTO object 参数解释: 请求参数对象。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 表4 PersistableModelUniqueKeyDTO 参数 是否必选 参数类型 描述 decrypt 否 Boolean 参数解释: 是否加密。 约束限制: 不涉及。 取值范围: true:加密。 false:不加密。 默认取值: false。 uniqueKey 是 String 参数解释: 示例模型的唯一键约束属性值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。
  • URI POST /rdm_{identifier}_app/publicservices/api/{modelName}/delete 表1 路径参数 参数 是否必选 参数类型 描述 identifier 是 String 参数解释: 应用唯一标识。 约束限制: 不涉及。 取值范围: 由英文字母和数字组成,且长度为32个字符。 默认取值: 不涉及。 modelName 是 String 参数解释: 数据模型的英文名称。 约束限制: 不涉及。 取值范围: 大写字母开头,只能包含字母、数字、"_",且长度为[1-60]个字符。 默认取值: 不涉及。
共100000条