华为云用户手册

  • 响应示例 状态码: 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" : [ ] }
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 result String 请求结果。 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 唯一标识。 iteration Integer 迭代版本。 kiaguid String KIA密级。 lastUpdateTime String 最后更新时间。 latest Boolean 是否为最新版本。 true:是最新版本。 false:不是最新版本。 latestIteration Boolean 是否为最新迭代版本。 true:是最新迭代版本。 false:不是最新迭代版本。 latestVersion Boolean 是否为最新修订版本。 true:是最新修订版本。 false:不是最新修订版本。 master VersionModelMasterViewDTO 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 工作状态。 表7 VersionModelBranchViewDTO 参数 参数类型 描述 className String 类名。 createTime String 创建时间。 creator String 创建者。 id String 唯一标识。 lastUpdateTime Object 最后更新时间。 modifier String 修改人。 rdmDeleteFlag Integer 软删除标识,参数值为0或1。 0:表示未删除。 1:表示已删除。 rdmExtensionType String 扩展类型。 rdmVersion Integer 系统版本。 tenant TenantViewDTO object 租户信息。 version String 版本号。 表8 VersionModelMasterViewDTO 参数 参数类型 描述 className String 类名。 createTime String 创建时间。 creator String 创建者。 id String 唯一标识。 lastUpdateTime String 最后更新时间。 modifier String 修改人。 rdmDeleteFlag Integer 软删除标识,参数值为0或1。 0:表示未删除。 1:表示已删除。 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:未失效。 id String 唯一标识。 kiaguid String KIA密级。 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 WorkingState 参数 参数类型 描述 alias String 别名。 cnName String 中文名称。 code String 编码。 enName String 英文名称。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM用户的token。 获取方法请参见获取IAM用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 applicationId 否 String 应用ID。 params 否 VersionModelVersionReviseDTO object 参数对象。 表4 VersionModelVersionReviseDTO 参数 是否必选 参数类型 描述 creator 否 String 创建人。 customLinkSet 否 Array of strings 关系实体名称集合,与workCopyType的值CUSTOM配合使用。 masterId 是 String 主对象ID。 modifier 否 String 更新者。 workCopyType 否 String 关系的复制类型。 BOTH:若存在关系实例引用此数据实例作为源端实例或目标端实例,修订后的数据实例将继承这些关系实例。 SOURCE:若存在关系实例引用此数据实例作为源端实例,修订后的数据实例将继承这些关系实例。 TARGET:若存在关系实例引用此数据实例作为目标端实例,修订后的数据实例将继承这些关系实例。 NONE:修订后的数据实例将不继承任何关系实例。 CUSTOM:若指定的关系实体集合对应的关系实例引用此数据实例作为源端实例或目标端实例,修订后的数据实例将继承这些关系实例。 workingCopy 否 Boolean 是否已检出。 true:已检出。 false:未检出。
  • 响应示例 状态码: 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" : "INWORK", "cnName" : "工作中", "enName" : "inwork", "alias" : "INWORK" }, "checkOutUserName" : "test1", "checkOutTime" : "2024-02-23T07:05:01.081+0000", "preVersionId" : 602511434441560064 } ], "errors" : [ ] }
  • 请求示例 POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/VersionModel/batchCheckoutAndUpdate { "applicationId" : "b3f9b7523a6141f4b2d76b92d6595281", "params" : [ { "creator" : "test1", "customLinkSet" : [ ], "data" : { "branch" : { "creator" : "test1", "id" : "602157284411318274", "modifier" : "test1", "needSetNullAttrs" : [ ], "rdmExtensionType" : "VersionModelBranch" }, "creator" : "test1", "description" : "this is the description used for the test.", "id" : "602157284411318272", "kiaguid" : "18409de0386546f8af4bb6c1dc5cf50f", "master" : { "creator" : "test1", "id" : "602157284411318273", "modifier" : "test1", "needSetNullAttrs" : [ ], "rdmExtensionType" : "VersionModelMaster" }, "modifier" : "test1", "name" : "this is the Chinese name used for testing.", "needSetNullAttrs" : [ "checkOutTime", "checkOutUserName" ], "rdmExtensionType" : "VersionModel", "securityLevel" : "internal" }, "masterId" : "602157284411318273", "modifier" : "test1", "workCopyType" : "BOTH" } ] }
  • 响应参数 状态码: 200 表8 响应Body参数 参数 参数类型 描述 result String 请求结果。 data Array of VersionModelViewDTO objects 请求数据。 errors Array of strings 异常信息。 表9 VersionModelViewDTO 参数 参数类型 描述 branch VersionModelBranchViewDTO object 分支对象。 checkOutTime String 检出时间。 checkOutUserName String 检出人。 className String 类名。 createTime String 创建时间。 creator String 创建者。 description String 描述信息。 id String 唯一标识。 iteration Integer 迭代版本。 kiaguid String KIA密级。 lastUpdateTime String 最后更新时间。 latest Boolean 是否为最新版本。 true:是最新版本。 false:不是最新版本。 latestIteration Boolean 是否为最新迭代版本。 true:是最新迭代版本。 false:不是最新迭代版本。 latestVersion Boolean 是否为最新修订版本。 true:是最新修订版本。 false:不是最新修订版本。 master VersionModelMasterViewDTO 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 工作状态。 表10 VersionModelBranchViewDTO 参数 参数类型 描述 className String 类名。 createTime String 创建时间。 creator String 创建者。 id String 唯一标识。 lastUpdateTime Object 最后更新时间。 modifier String 修改人。 rdmDeleteFlag Integer 软删除标识,参数值为0或1。 0:表示未删除。 1:表示已删除。 rdmExtensionType String 扩展类型。 rdmVersion Integer 系统版本。 tenant TenantViewDTO object 租户信息。 version String 版本号。 表11 VersionModelMasterViewDTO 参数 参数类型 描述 className String 类名。 createTime String 创建时间。 creator String 创建者。 id String 唯一标识。 lastUpdateTime String 最后更新时间。 modifier String 修改人。 rdmDeleteFlag Integer 软删除标识,参数值为0或1。 0:表示未删除。 1:表示已删除。 rdmExtensionType String 扩展类型。 rdmVersion Integer 系统版本。 tenant TenantViewDTO object 租户信息。 表12 TenantViewDTO 参数 参数类型 描述 className String 类名。 code String 租户编码。 createTime String 创建时间。 creator String 创建者。 dataSource String 租户使用的数据源名称。 description String 描述信息。 disableFlag Boolean 失效标识。 true:失效。 false:未失效。 id String 唯一标识。 kiaguid String KIA密级。 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 租户信息。 表13 WorkingState 参数 参数类型 描述 alias String 别名。 cnName String 中文名称。 code String 编码。 enName String 英文名称。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM用户的token。 获取方法请参见获取IAM用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 applicationId 否 String 应用ID。 params 否 Array of VersionModelVersionCheckoutAndUpdateDTOVersionModel objects 参数对象。 表4 VersionModelVersionCheckoutAndUpdateDTOVersionModel 参数 是否必选 参数类型 描述 creator 否 String 创建人。 customLinkSet 否 Array of strings 关系实体名称集合,与workCopyType的值CUSTOM配合使用。 data 是 VersionModel object 检出后用于实例更新的数据对象。 masterId 是 String 主对象ID。 modifier 否 String 更新者。 workCopyType 否 String 关系的复制类型。 BOTH:若存在关系实例引用此数据实例作为源端实例或目标端实例,检出并更新后的数据实例将继承这些关系实例。 SOURCE:若存在关系实例引用此数据实例作为源端实例,检出并更新后的数据实例将继承这些关系实例。 TARGET:若存在关系实例引用此数据实例作为目标端实例,检出并更新后的数据实例将继承这些关系实例。 NONE:检出并更新后的数据实例将不继承任何关系实例。 CUSTOM:若指定的关系实体集合对应的关系实例引用此数据实例作为源端实例或目标端实例,检出并更新后的数据实例将继承这些关系实例。 表5 VersionModel 参数 是否必选 参数类型 描述 branch 否 VersionModelBranch object 分支对象。 checkOutTime 否 String 检出时间。 checkOutUserName 否 String 检出用户名称。 createTime 否 String 创建时间。 creator 否 String 创建者。 description 否 String 描述信息。 id 否 String 唯一标识。 kiaguid 否 String 关键信息资产ID。 lastUpdateTime 否 String 最后更新时间。 master 否 VersionModelMaster object 主对象。 modifier 否 String 更新者。 name 否 String 中文名称。 needSetNullAttrs 否 Array of strings 设置NULL值的属性名称。 rdmExtensionType 否 String 扩展类型。 securityLevel 否 String 安全密级。 INTERNAL:内部公开。 SECRET:秘密。 CONFIDENTIAL:机密。 TOP_SECRET:绝密。 表6 VersionModelBranch 参数 是否必选 参数类型 描述 createTime 否 String 创建时间。 creator 否 String 创建者。 id 否 String 唯一标识。 lastUpdateTime 否 String 最后更新时间。 modifier 否 String 更新者。 needSetNullAttrs 否 Array of strings 设置NULL值的属性名称。 rdmExtensionType 否 String 扩展类型。 表7 VersionModelMaster 参数 是否必选 参数类型 描述 createTime 否 String 创建时间。 creator 否 String 创建者。 id 是 String 唯一标识。 lastUpdateTime 否 String 最后更新时间。 modifier 否 String 更新者。 needSetNullAttrs 否 Array of strings 设置NULL值的属性名称。 rdmExtensionType 否 String 扩展类型。
  • 请求示例 POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/VersionModel/batchReviseAndUpdate { "applicationId" : "b3f9b7523a6141f4b2d76b92d6595281", "params" : [ { "creator" : "test1", "modifier" : "test1", "customLinkSet" : [ ], "masterId" : "602157284411318273", "workCopyType" : "BOTH", "workingCopy" : false, "data" : { "id" : "602157284411318272", "name" : "this is the Chinese name used for testing.", "kiaguid" : "18409de0386546f8af4bb6c1dc5cf50f", "modifier" : "test1", "creator" : "test1", "description" : "this is the description used for the test.", "securityLevel" : "internal", "rdmExtensionType" : "VersionModel", "needSetNullAttrs" : [ "checkOutTime", "checkOutUserName" ], "branch" : { "id" : "602157284411318274", "creator" : "test1", "modifier" : "test1", "rdmExtensionType" : "VersionModelBranch", "needSetNullAttrs" : [ ] }, "master" : { "id" : "602157284411318273", "creator" : "test1", "modifier" : "test1", "rdmExtensionType" : "VersionModelMaster", "needSetNullAttrs" : [ ] } } } ] }
  • 响应示例 状态码: 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" : [ ] }
  • 响应参数 状态码: 200 表8 响应Body参数 参数 参数类型 描述 result String 请求结果。 data Array of VersionModelViewDTO objects 请求数据。 errors Array of strings 异常信息。 表9 VersionModelViewDTO 参数 参数类型 描述 branch VersionModelBranchViewDTO object 分支对象。 checkOutTime String 检出时间。 checkOutUserName String 检出人。 className String 类名。 createTime String 创建时间。 creator String 创建者。 description String 描述信息。 id String 唯一标识。 iteration Integer 迭代版本。 kiaguid String KIA密级。 lastUpdateTime String 最后更新时间。 latest Boolean 是否为最新版本。 true:是最新版本。 false:不是最新版本。 latestIteration Boolean 是否为最新迭代版本。 true:是最新迭代版本。 false:不是最新迭代版本。 latestVersion Boolean 是否为最新修订版本。 true:是最新修订版本。 false:不是最新修订版本。 master VersionModelMasterViewDTO 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 工作状态。 表10 VersionModelBranchViewDTO 参数 参数类型 描述 className String 类名。 createTime String 创建时间。 creator String 创建者。 id String 唯一标识。 lastUpdateTime Object 最后更新时间。 modifier String 修改人。 rdmDeleteFlag Integer 软删除标识,参数值为0或1。 0:表示未删除。 1:表示已删除。 rdmExtensionType String 扩展类型。 rdmVersion Integer 系统版本。 tenant TenantViewDTO object 租户信息。 version String 版本号。 表11 VersionModelMasterViewDTO 参数 参数类型 描述 className String 类名。 createTime String 创建时间。 creator String 创建者。 id String 唯一标识。 lastUpdateTime String 最后更新时间。 modifier String 修改人。 rdmDeleteFlag Integer 软删除标识,参数值为0或1。 0:表示未删除。 1:表示已删除。 rdmExtensionType String 扩展类型。 rdmVersion Integer 系统版本。 tenant TenantViewDTO object 租户信息。 表12 TenantViewDTO 参数 参数类型 描述 className String 类名。 code String 租户编码。 createTime String 创建时间。 creator String 创建者。 dataSource String 租户使用的数据源名称。 description String 描述信息。 disableFlag Boolean 失效标识。 true:失效。 false:未失效。 id String 唯一标识。 kiaguid String KIA密级。 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 租户信息。 表13 WorkingState 参数 参数类型 描述 alias String 别名。 cnName String 中文名称。 code String 编码。 enName String 英文名称。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM用户的token。 获取方法请参见获取IAM用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 applicationId 否 String 应用ID。 params 否 Array of VersionModelVersionReviseAndUpdateDTOVersionModel objects 参数对象。 表4 VersionModelVersionReviseAndUpdateDTOVersionModel 参数 是否必选 参数类型 描述 creator 否 String 创建人。 customLinkSet 否 Array of strings 关系实体名称集合,与workCopyType的值CUSTOM配合使用。 data 是 VersionModel object 实例修订时,用于更新实例的数据对象。 masterId 是 String 主对象ID。 modifier 否 String 更新者。 workCopyType 否 String 关系的复制类型。 BOTH:若存在关系实例引用此数据实例作为源端实例或目标端实例,修订且更新后的数据实例将继承这些关系实例。 SOURCE:若存在关系实例引用此数据实例作为源端实例,修订且更新后的数据实例将继承这些关系实例。 TARGET:若存在关系实例引用此数据实例作为目标端实例,修订且更新后的数据实例将继承这些关系实例。 NONE:修订且更新后的数据实例将不继承任何关系实例。 CUSTOM:若指定的关系实体集合对应的关系实例引用此数据实例作为源端实例或目标端实例,修订且更新后的数据实例将继承这些关系实例。 workingCopy 否 Boolean 是否已检出。 true:已检出。 false:未检出。 表5 VersionModel 参数 是否必选 参数类型 描述 branch 否 VersionModelBranch object 分支对象。 checkOutTime 否 String 检出时间。 checkOutUserName 否 String 检出用户名称。 createTime 否 String 创建时间。 creator 否 String 创建者。 description 否 String 描述信息。 id 否 String 唯一标识。 kiaguid 否 String 关键信息资产ID。 lastUpdateTime 否 String 最后更新时间。 master 否 VersionModelMaster object 主对象。 modifier 否 String 更新者。 name 否 String 中文名称。 needSetNullAttrs 否 Array of strings 设置NULL值的属性名称。 rdmExtensionType 否 String 扩展类型。 securityLevel 否 String 安全密级。 INTERNAL:内部公开。 SECRET:秘密。 CONFIDENTIAL:机密。 TOP_SECRET:绝密。 表6 VersionModelBranch 参数 是否必选 参数类型 描述 createTime 否 String 创建时间。 creator 否 String 创建者。 id 否 String 唯一标识。 lastUpdateTime 否 String 最后更新时间。 modifier 否 String 更新者。 needSetNullAttrs 否 Array of strings 设置NULL值的属性名称。 rdmExtensionType 否 String 扩展类型。 表7 VersionModelMaster 参数 是否必选 参数类型 描述 createTime 否 String 创建时间。 creator 否 String 创建者。 id 是 String 唯一标识。 lastUpdateTime 否 String 最后更新时间。 modifier 否 String 更新者。 needSetNullAttrs 否 Array of strings 设置NULL值的属性名称。 rdmExtensionType 否 String 扩展类型。
  • 响应示例 状态码: 200 OK { "result" : "SUCCESS", "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 请求结果。 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 唯一标识。 iteration Integer 迭代版本。 kiaguid String KIA密级。 lastUpdateTime String 最后更新时间。 latest Boolean 是否为最新版本。 true:是最新版本。 false:不是最新版本。 latestIteration Boolean 是否为最新迭代版本。 true:是最新迭代版本。 false:不是最新迭代版本。 latestVersion Boolean 是否为最新修订版本。 true:是最新修订版本。 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 唯一标识。 lastUpdateTime Object 最后更新时间。 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 唯一标识。 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 唯一标识。 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:未失效。 id String 唯一标识。 kiaguid String KIA密级。 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 租户信息。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM用户的token。 获取方法请参见获取IAM用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 params 否 Array of MultiViewModelVersionViewCreateDTO objects 参数对象。 applicationId 否 String 应用ID。 表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。
  • 响应示例 状态码: 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" : "INWORK", "cnName" : "工作中", "enName" : "inwork", "alias" : "INWORK" }, "checkOutUserName" : "test1", "checkOutTime" : "2024-02-23T07:05:01.081+0000", "preVersionId" : 602511434441560064 } ], "errors" : [ ] }
  • 请求示例 POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/VersionModel/checkoutAndUpdate { "applicationId" : "b3f9b7523a6141f4b2d76b92d6595281", "params" : { "creator" : "test1", "customLinkSet" : [ ], "data" : { "branch" : { "creator" : "test1", "id" : "602157284411318274", "modifier" : "test1", "needSetNullAttrs" : [ ], "rdmExtensionType" : "VersionModelBranch" }, "creator" : "test1", "description" : "this is the description used for the test.", "id" : "602157284411318272", "kiaguid" : "18409de0386546f8af4bb6c1dc5cf50f", "master" : { "creator" : "test1", "id" : "602157284411318273", "modifier" : "test1", "needSetNullAttrs" : [ ], "rdmExtensionType" : "VersionModelMaster" }, "modifier" : "test1", "name" : "this is the Chinese name used for testing.", "needSetNullAttrs" : [ "checkOutTime", "checkOutUserName" ], "rdmExtensionType" : "VersionModel", "securityLevel" : "internal" }, "masterId" : "602157284411318273", "modifier" : "test1", "workCopyType" : "BOTH" } }
  • 响应参数 状态码: 200 表8 响应Body参数 参数 参数类型 描述 result String 请求结果。 data Array of VersionModelViewDTO objects 请求数据。 errors Array of strings 异常信息。 表9 VersionModelViewDTO 参数 参数类型 描述 branch VersionModelBranchViewDTO object 分支对象。 checkOutTime String 检出时间。 checkOutUserName String 检出人。 className String 类名。 createTime String 创建时间。 creator String 创建者。 description String 描述信息。 id String 唯一标识。 iteration Integer 迭代版本。 kiaguid String KIA密级。 lastUpdateTime String 最后更新时间。 latest Boolean 是否为最新版本。 true:是最新版本。 false:不是最新版本。 latestIteration Boolean 是否为最新迭代版本。 true:是最新迭代版本。 false:不是最新迭代版本。 latestVersion Boolean 是否为最新修订版本。 true:是最新修订版本。 false:不是最新修订版本。 master VersionModelMasterViewDTO 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 工作状态。 表10 VersionModelBranchViewDTO 参数 参数类型 描述 className String 类名。 createTime String 创建时间。 creator String 创建者。 id String 唯一标识。 lastUpdateTime Object 最后更新时间。 modifier String 修改人。 rdmDeleteFlag Integer 软删除标识,参数值为0或1。 0:表示未删除。 1:表示已删除。 rdmExtensionType String 扩展类型。 rdmVersion Integer 系统版本。 tenant TenantViewDTO object 租户信息。 version String 版本号。 表11 VersionModelMasterViewDTO 参数 参数类型 描述 className String 类名。 createTime String 创建时间。 creator String 创建者。 id String 唯一标识。 lastUpdateTime String 最后更新时间。 modifier String 修改人。 rdmDeleteFlag Integer 软删除标识,参数值为0或1。 0:表示未删除。 1:表示已删除。 rdmExtensionType String 扩展类型。 rdmVersion Integer 系统版本。 tenant TenantViewDTO object 租户信息。 表12 TenantViewDTO 参数 参数类型 描述 className String 类名。 code String 租户编码。 createTime String 创建时间。 creator String 创建者。 dataSource String 租户使用的数据源名称。 description String 描述信息。 disableFlag Boolean 失效标识。 true:失效。 false:未失效。 id String 唯一标识。 kiaguid String KIA密级。 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 租户信息。 表13 WorkingState 参数 参数类型 描述 alias String 别名。 cnName String 中文名称。 code String 编码。 enName String 英文名称。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM用户的token。 获取方法请参见获取IAM用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 applicationId 否 String 应用ID。 params 否 VersionModelVersionCheckoutAndUpdateDTOVersionModel object 参数对象。 表4 VersionModelVersionCheckoutAndUpdateDTOVersionModel 参数 是否必选 参数类型 描述 creator 否 String 创建人。 customLinkSet 否 Array of strings 关系实体名称集合,与workCopyType的值CUSTOM配合使用。 data 是 VersionModel object 检出后用于实例更新的数据对象。 masterId 是 String 主对象ID。 modifier 否 String 更新者。 workCopyType 否 String 关系的复制类型。 BOTH:若存在关系实例引用此数据实例作为源端实例或目标端实例,检出并更新后的数据实例将继承这些关系实例。 SOURCE:若存在关系实例引用此数据实例作为源端实例,检出并更新后的数据实例将继承这些关系实例。 TARGET:若存在关系实例引用此数据实例作为目标端实例,检出并更新后的数据实例将继承这些关系实例。 NONE:检出并更新后的数据实例将不继承任何关系实例。 CUSTOM:若指定的关系实体集合对应的关系实例引用此数据实例作为源端实例或目标端实例,检出并更新后的数据实例将继承这些关系实例。 表5 VersionModel 参数 是否必选 参数类型 描述 branch 否 VersionModelBranch object 分支对象。 checkOutTime 否 String 检出时间。 checkOutUserName 否 String 检出用户名称。 createTime 否 String 创建时间。 creator 否 String 创建者。 description 否 String 描述信息。 id 否 String 唯一标识。 kiaguid 否 String 关键信息资产ID。 lastUpdateTime 否 String 最后更新时间。 master 否 VersionModelMaster object 主对象。 modifier 否 String 更新者。 name 否 String 中文名称。 needSetNullAttrs 否 Array of strings 设置NULL值的属性名称。 rdmExtensionType 否 String 扩展类型。 securityLevel 否 String 安全密级。 INTERNAL:内部公开。 SECRET:秘密。 CONFIDENTIAL:机密。 TOP_SECRET:绝密。 表6 VersionModelBranch 参数 是否必选 参数类型 描述 createTime 否 String 创建时间。 creator 否 String 创建者。 id 否 String 唯一标识。 lastUpdateTime 否 String 最后更新时间。 modifier 否 String 更新者。 needSetNullAttrs 否 Array of strings 设置NULL值的属性名称。 rdmExtensionType 否 String 扩展类型。 表7 VersionModelMaster 参数 是否必选 参数类型 描述 createTime 否 String 创建时间。 creator 否 String 创建者。 id 是 String 唯一标识。 lastUpdateTime 否 String 最后更新时间。 modifier 否 String 更新者。 needSetNullAttrs 否 Array of strings 设置NULL值的属性名称。 rdmExtensionType 否 String 扩展类型。
  • 请求消息体(可选) 请求消息体通常以结构化格式(如JSON或XML)发出,与请求消息头中Content-Type对应,传递除请求消息头之外的内容。若请求消息体中的参数支持中文,则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于获取用户Token接口,您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示,加粗的斜体字段需要根据实际值填写,其中username为用户名,domainname为用户所属的账号名称,********为用户登录密码,xxxxxxxxxx为project的名称,如“cn-north-4”,您可以从地区和终端节点中获取。 scope参数定义了Token的作用域,下面示例中获取的Token仅能访问project下的资源。您还可以设置Token的作用域为某个账号下所有资源或账号的某个project下的资源,详细定义请参见获取用户Token。 POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } } } 到这里为止这个请求需要的内容就具备齐全了,您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口,返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后,您就可以使用Token认证调用其他API。
  • 请求URI 请求URI由如下部分组成。 {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string} 尽管请求URI包含在请求消息头中,但大多数语言或框架都要求您从请求消息中单独传递它,所以在此单独强调。 表1 URI中的参数说明 参数 描述 URI-scheme 表示用于传输请求的协议,当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器域名或IP,不同服务不同区域的Endpoint不同,您可以从地区和终端节点中获取。例如IAM服务在“华北-北京四”区域的Endpoint为“iam.cn-north-4.myhuaweicloud.com”。 resource-path 资源路径,也即API访问路径。从具体API的URI模块获取,例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string 查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“?limit=10”,表示查询不超过10条数据。 例如您需要获取IAM在“华北-北京四”区域的Token,则需使用“华北-北京四”区域的Endpoint(iam.cn-north-4.myhuaweicloud.com),并在获取用户Token的URI部分找到resource-path(/v3/auth/tokens),拼接起来如下所示。 https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为查看方便,在每个具体API的URI部分,只给出resource-path部分,并将请求方法写在一起。这是因为URI-scheme都是HTTPS,而Endpoint在同一个区域也相同,所以简洁起见将这两部分省略。
  • 请求方法 HTTP请求方法(也称为操作或动词),它告诉服务您正在请求什么类型的操作。 表2 HTTP请求方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源,如删除对象等。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。当资源不存在的时候,PATCH可能会去创建一个新的资源。 在获取用户Token的URI部分,您可以看到其请求方法为“POST”,则其请求为: POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens
  • 请求消息头 附加请求头字段,如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”,请求鉴权信息等。 详细的公共请求消息头字段请参见表3。 表3 公共请求消息头 名称 描述 是否必选 示例 Host 请求的服务器信息,从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口,https的默认端口为443。 否 使用AK/SK认证时该字段必选。 code.test.com or code.test.com:443 Content-Type 消息体的类型(格式)。推荐用户使用默认值application/json,有其他取值时会在具体接口中专门说明。 是 application/json Content-Length 请求body长度,单位为Byte。 否 3495 X-Project-Id Project ID,项目编号。请参考获取项目ID章节获取项目编号。 否 如果是专属云场景采用AK/SK认证方式的接口请求或者多project场景采用AK/SK认证的接口请求,则该字段必选。 e9993fc787d94b6c886cbaa340f9c0f4 X-Auth-Token 用户Token。 用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头(Headers)中包含的“X-Subject-Token”的值即为Token值。 否 使用Token认证时该字段必选。 注:以下仅为Token示例片段 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ API同时支持使用AK/SK认证,AK/SK认证是使用SDK对请求进行签名,签名过程会自动往请求中添加Authorization(签名认证信息)和X-Sdk-Date(请求发送的时间)请求头。 AK/SK认证的详细说明请参见认证鉴权的“AK/SK认证”。 对于获取用户Token接口,由于不需要认证,所以只添加“Content-Type”即可,添加消息头后的请求如下所示。 POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json
  • 请求参数 表2 请求body参数 参数 是否必填 参数类型 描述 versionId 是 Integer 原视图的versionId,即已创建数据实例的version.唯一编码。 workCopyType 否 Object 此配置项用于创建多维版本数据实例时是否继承其对应的关系实例。根据业务需求,选择类型。 BOTH:若存在关系实例引用此数据实例作为源端实例或目标端实例,创建后的数据实例将继承这些关系实例。 SOURCE:若存在关系实例引用此数据实例作为源端实例,创建后的数据实例将继承这些关系实例。 TARGET:若存在关系实例引用此数据实例作为目标端实例,创建后的数据实例将继承这些关系实例。 NONE:创建后的数据实例将不继承任何关系实例。 CUSTOM:若指定的关系实体集合对应的关系实例引用此数据实例作为源端实例或目标端实例,创建后的数据实例将继承这些关系实例。 customLinkSet 否 List 关系实体名称的集合。 当“workCopyType”设置为“CUSTOM”时,需要设置此参数。 needSetNull 否 List 指定不复制的属性。被指定不复制的属性,其返回值将被设置为“null”。 modifier 是 String 更新者。 如果用户在应用设计态创建多维视图&多维分支功能的数据实体时,将“多维版本”功能配置新增的属性设置为必填,该数据实体的API请求参数中需设置相应参数。
  • 请求示例 示例背景 假设,您已在cn-north-4区域的TestApp应用中,构建一个名称为“TestMV”的M-V模型数据实体,并完成了实体发布、应用发布和应用部署。希望可以根据已创建的M-V模型数据实例,创建一个多维版本数据实例。 示例代码 { "params": { "versionId": "521722330943061234", "modifier": "DME_Developer", "view2": { "id": "11", "clazz": "ViewAttr" } } }
  • 响应示例 为篇幅起见,这里只展示部分内容。 { "result": "SUCCESS", "data": [ { "id": "523616294595981234", ...... "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "View2", "tenant": { ...... }, "className": "View2", "name": "AS", "description": null, "kiaguid": null, "securityLevel": "internal", "master": { ...... "rdmExtensionType": "View2Master", "tenant": { ...... }, "className": "View2Master" }, "branch": { ...... "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "View2Branch", "tenant": { ...... }, "className": "View2Branch", "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": "52281****087179264", "viewAttr1": null, "viewAttr3": null, "viewAttr2": null } ], "errors": [] }
  • URI URL格式: POST http://{Endpoint}/rdm_{appID}_app/publicservices/api/{entityName}/createView 参数说明: 表1 URI参数说明 参数 是否必填 参数类型 描述 Endpoint 是 String 承载REST服务端点的服务器域名或IP地址。 appID 是 String 应用ID。 entityName 是 String 实体的英文名称。
  • 计费说明 分布式消息服务Kafka版的计费项由实例费用和存储空间费用组成。具体内容如表1所示。 表1 分布式消息服务Kafka版计费项 计费项 计费项说明 适用的计费模式 计费公式 实例费用 计费因子:代理规格和代理数量 如果开启Smart Connect,实例需要另外收取用于Smart Connect的代理费用。 包年/包月、按需计费 实例规格单价 * 购买时长 实例规格单价请参见分布式消息服务Kafka版价格详情中的“实例价格”。 存储空间费用 计费因子:云硬盘类型、容量 包年/包月、按需计费 云硬盘单价 * 购买时长 云硬盘单价请参见分布式消息服务Kafka版价格详情中的“存储价格”。
  • 计费示例 以包年/包月计费模式为例,假设您于2023/03/08 15:50:04在“华北-北京四”区域购买了一个包年/包月Kafka实例(规格:kafka.2u4g.cluster*3,总存储空间:超高I/O 300GB),计费资源包括实例费用(代理规格和代理数量),以及存储空间费用(超高I/O 300GB)。购买时长为一个月,并在到期前手动续费1个月,则: 第一个计费周期为:2023/03/08 15:50:04 ~ 2023/04/08 23:59:59 第二个计费周期为:2023/04/08 23:59:59 ~ 2023/05/08 23:59:59 图1给出了上述示例配置的费用计算过程。 图中价格仅供参考,实际计算请以分布式消息服务Kafka版价格详情中的价格为准。 图1 包年/包月Kafka实例费用计算示例(华北-北京四区域) 按需计费模式下,各计费项的计费示例请参见计费示例。
  • 计费周期 按需计费Kafka实例按秒计费,每一个小时整点结算一次费用(以UTC+8时间为准),结算完毕后进入新的计费周期。计费的起点以Kafka实例创建成功的时间点为准,终点以实例删除时间为准。 例如,您在8:45:30购买了一个按需计费的Kafka实例,然后在8:55:00将其删除,则计费周期为8:00:00 ~ 9:00:00,在8:45:30 ~ 8:55:30间产生费用,该计费周期内的计费时长为600秒。
共100000条