华为云用户手册

  • 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的整数。 默认取值: 不涉及。
  • 前提条件 已开通工业数字模型驱动引擎(Industrial Digital Model Engine,简称iDME),并根据开通区域确定调用API的Endpoint,详细信息请参见地区与终端节点。 当您使用Token认证方式完成认证鉴权时,需要获取用户Token并在调用接口时增加“X-Auth-Token”到业务接口请求消息头中。Token认证,具体操作请参考认证鉴权。 请注意,通过IAM服务获取到的Token有效期为24小时,需要使用同一个Token鉴权时,可以先将Token缓存,避免频繁调用。
  • 操作步骤 获取待删除的应用ID。 接口相关信息 URI格式:GET /v1/{project_id}/apps 详情请参见获取租户下的应用清单。 请求示例 GET https://{iDME Endpoint}/v1/{project_id}/apps {project_id}请从获取项目ID获取。 响应示例 { "result": [ { "id": "44145d41ae294e111111eafd4da32ea8", "project_id": "cf49a20d85294c93b1111111ca9454bc", "mark_for_delete": 0, "create_by": "59779076d1dc********c91c2c54bd7a", "create_time": 1690427901000, "update_by": "59779076d1dc********c91c2c54bd7a", "update_time": 1690427901000, "name_cn": "TestApp", "name_en": "TestApp", "desc_cn": "", "desc_en": "", "database_type": "mysql", "environment": "beta", "owners": [ "user_1", "idme_container1" ] }, { "id": "c787dcd484944ad11111dd18693e4eb2", "project_id": "cf49a20d85294c93b1111111ca9454bc", "mark_for_delete": 0, "create_by": "59779076d1dc********c91c2c54bd7a", "create_time": 1689622165000, "update_by": "59779076d1dc********c91c2c54bd7a", "update_time": 1689622165000, "name_cn": "工业产品问卷调查", "name_en": "Questionnaire_Survey", "desc_cn": "", "desc_en": "", "database_type": "mysql", "environment": "dev", "owners": [ "dme-console" ] } ], "page_num": 1, "page_size": 500, "total_size": 2, "total_pages": 1 } 删除应用。 接口相关信息 URI格式:DELETE /v1/{project_id}/apps/{app_id} 详情请参见删除应用。 请求示例 DELETE https://{iDME Endpoint}/v1/cf49a20d85294c93b1111111ca9454bc/apps/44145d41ae294e111111eafd4da32ea8 响应示例 { "result": "SUC CES S", "error_msg": null } 请求异常时,错误码请参见错误码。
  • 请求示例 POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/TreeableModel/getChildList/10/1 { "params" : { "parentId" : "616948972547739648" } }
  • 响应示例 状态码: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 } }
  • 响应参数 状态码: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 参数解释: 总页数。 取值范围: 不涉及。 默认取值: 不涉及。
  • 请求参数 表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。
  • 请求示例 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:源模型。 默认取值: 不涉及。
  • 请求示例 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" : [ ] }
  • URI POST /rdm_{identifier}_app/publicservices/api/{modelName}/{getUniqueFieldMethod} 表1 路径参数 参数 是否必选 参数类型 描述 identifier 是 String 参数解释: 应用唯一标识。 约束限制: 不涉及。 取值范围: 由英文字母和数字组成,且长度为32个字符。 默认取值: 不涉及。 modelName 是 String 参数解释: 数据模型的英文名称。 约束限制: 不涉及。 取值范围: 大写字母开头,只能包含字母、数字、“_”,且长度为[1-60]个字符。 默认取值: 不涉及。 getUniqueFieldMethod 是 String 参数解释: 方法名称,格式为:getBy{uniqueName}。 uniqueName:表示“唯一键”为“是”的属性英文名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。
  • 响应参数 状态码: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 AnyType 参数解释: 最后更新时间。 取值范围: 不涉及。 默认取值: 不涉及。 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 参数解释: 租户信息。 取值范围: 不涉及。 默认取值: 不涉及。
  • 请求参数 表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 参数解释: 示例模型的唯一键约束属性值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。
  • 请求示例 POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/PersistableModel/delete { "applicationId" : "b3f9b7523a6141f4b2d76b92d6595281", "params" : { "id" : "777", "modifier" : "test1" } }
  • URI POST /rdm_{identifier}_app/publicservices/api/{modelName}/delete 表1 路径参数 参数 是否必选 参数类型 描述 identifier 是 String 参数解释: 应用唯一标识。 约束限制: 不涉及。 取值范围: 由英文字母和数字组成,且长度为32个字符。 默认取值: 不涉及。 modelName 是 String 参数解释: 数据模型的英文名称。 约束限制: 不涉及。 取值范围: 大写字母开头,只能包含字母、数字、“_”,且长度为[1-60]个字符。 默认取值: 不涉及。
  • 响应参数 状态码:200 表5 响应Body参数 参数 参数类型 描述 result String 参数解释: 请求结果。 取值范围: SUCCESS:请求成功。 FAIL:请求失败。 默认取值: 不涉及。 data Array of longs 参数解释: 请求操作数据数量。 取值范围: 不涉及。 默认取值: 不涉及。 errors Array of strings 参数解释: 异常信息。 取值范围: 不涉及。 默认取值: 不涉及。
  • 请求参数 表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 参数解释: 请求参数对象。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释: IAM用户的token。 获取方法请参见获取IAM用户Token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 applicationId 否 String 参数解释: 应用ID。 约束限制: 不涉及。 取值范围: 由英文字母和数字组成,且长度为32个字符。 默认取值: 不涉及。 params 否 PersistObjectIdDTO object 参数解释: 请求参数对象。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 表4 PersistObjectIdDTO 参数 是否必选 参数类型 描述 id 是 String 参数解释: 数据实例ID。 约束限制: 不涉及。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。
  • 响应参数 状态码:200 表5 响应Body参数 参数 参数类型 描述 result String 参数解释: 请求结果。 取值范围: SUCCESS:请求成功。 FAIL:请求失败。 默认取值: 不涉及。 data Array of objects 参数解释: 请求数据。 取值范围: 不涉及。 默认取值: 不涉及。 errors Array of strings 参数解释: 异常信息。 取值范围: 不涉及。 默认取值: 不涉及。
  • 响应示例 状态码:200 OK { "result" : "SUCCESS", "data" : [ { "id" : "609779121987260416", "creator" : "test1", "createTime" : "2023-12-04T11:52:48.000+0000", "modifier" : "test1", "lastUpdateTime" : "2023-12-04T12:07:59.000+0000", "rdmVersion" : 1, "rdmDeleteFlag" : 0, "rdmExtensionType" : "Tag", "tenant" : { "id" : "-1", "creator" : "xdmAdmin", "createTime" : "2023-12-01T01:25:21.000+0000", "modifier" : "xdmAdmin", "lastUpdateTime" : "2023-12-01T01:25:21.000+0000", "rdmVersion" : 1, "rdmDeleteFlag" : 0, "rdmExtensionType" : "Tenant", "tenant" : null, "className" : "Tenant", "name" : "basicTenant", "description" : "默认租户", "code" : "basicTenant", "disableFlag" : false, "dataSource" : "DefaultDataSource" }, "className" : "Tag", "name" : null, "description" : "测试标签", "kiaguid" : null, "securityLevel" : "internal", "nameCn" : "测试标签", "nameEn" : "Tag1", "type" : null, "group" : { "id" : "609778926910181376", "creator" : "test1", "modifier" : "test1", "createTime" : "2024-03-14T08:03:45.000+0000", "lastUpdateTime" : "2024-03-14T08:04:17.000+0000", "rdmVersion" : 2, "rdmDeleteFlag" : 0, "rdmExtensionType" : "TagGroup", "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" : "TagGroup", "name" : null, "description" : "这是一个标签", "kiaguid" : null, "securityLevel" : "internal", "color" : { "code" : "GRAY", "cnName" : "灰色", "enName" : "GRAY", "alias" : "GRAY" }, "nameCn" : "这是一个标签组", "nameEn" : "TagGroup1", "rootNode" : null, "parentNode" : null, "leafFlag" : true, "fullPath" : "609778926910181376", "rawFullPath" : "609778926910181376" } } ], "errors" : [ ] }
  • URI POST /rdm_{identifier}_app/publicservices/api/{modelName}/queryTag 表1 路径参数 参数 是否必选 参数类型 描述 identifier 是 String 参数解释: 应用唯一标识。 约束限制: 不涉及。 取值范围: 由英文字母和数字组成,且长度为32个字符。 默认取值: 不涉及。 modelName 是 String 参数解释: 数据模型的英文名称。 约束限制: 不涉及。 取值范围: 大写字母开头,只能包含字母、数字、“_”,且长度为[1-60]个字符。 默认取值: 不涉及。
  • 请求示例 POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/TagableModel/queryTag { "applicationId" : "b3f9b7523a6141f4b2d76b92d6595281", "params" : { "id" : "1" } }
  • 请求示例 POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/DisabledModel/disable { "applicationId" : "b3f9b7523a6141f4b2d76b92d6595281", "params" : { "ids" : [ "1" ], "modifier" : "test1" } }
  • 响应参数 状态码:200 表5 响应Body参数 参数 参数类型 描述 result String 参数解释: 请求结果。 取值范围: SUCCESS:请求成功。 FAIL:请求失败。 默认取值: 不涉及。 data Array of integers 参数解释: 请求数据。 取值范围: 不涉及。 默认取值: 不涉及。 errors Array of strings 参数解释: 异常信息。 取值范围: 不涉及。 默认取值: 不涉及。
共100000条