华为云用户手册

URI POST /rdm_{identifier}_app/publicservices/api/{modelName}/select/{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/PersistableModel/select/10/1 { "applicationId" : "b3f9b7523a6141f4b2d76b92d6595281", "params" : { "selectedField" : [ { "name" : "rdmExtensionType", "nameAs" : "nameAsRdmExtensionType" } ], "characterSet" : "UTF8", "isNeedTotal" : true, "isPresentAll" : true, "publicData" : "INCLUDE_PUBLIC_DATA", "sorts" : [ ], "decrypt" : false, "filter" : { "joiner" : "and", "ignoreStr" : false, "conditions" : [ { "conditionName" : "rdmExtensionType", "operator" : "=", "conditionValues" : [ "PersistableModel" ], "ignoreStr" : false } ] } } }

响应参数 状态码：200 表10 响应Body参数 参数 参数类型 描述 result String 参数解释： 请求结果。 取值范围： SUC CES S：请求成功。 FAIL：请求失败。 默认取值： 不涉及。 data Array of objects 参数解释： 请求参数对象。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 errors Array of strings 参数解释： 异常信息。 取值范围： 不涉及。 默认取值： 不涉及。

URI DELETE /v1/{project_id}/apps/{app_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为[1-36]个字符。 默认取值： 不涉及。 app_id 是 String 参数解释： 应用ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

响应示例 状态码：200 OK { "result" : "SUCCESS", "data" : [ { "id" : "721366695490363392", "creator" : "XDM_Developer 93172bbfd0f64437956d4c9de9345386", "modifier" : "XDM_Developer 93172bbfd0f64437956d4c9de9345386", "createTime" : "2025-01-16T06:13:42.550+0000", "lastUpdateTime" : "2025-01-16T06:13:42.550+0000", "rdmVersion" : 1, "rdmDeleteFlag" : 0, "rdmExtensionType" : "StructuredDocShare", "tenant" : { "id" : "-1", "creator" : "xdmAdmin", "modifier" : "xdmAdmin", "createTime" : "2024-11-13T08:27:59.903+0000", "lastUpdateTime" : "2024-11-13T08:27:59.903+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" : "StructuredDocShare", "structuredDoc" : { "id" : "721022465261703168", "creator" : "XDM_Developer 93172bbfd0f64437956d4c9de9345386", "modifier" : "XDM_Developer 93172bbfd0f64437956d4c9de9345386", "createTime" : "2025-01-15T07:25:51.668+0000", "lastUpdateTime" : "2025-01-15T07:25:51.668+0000", "rdmVersion" : 1, "rdmDeleteFlag" : 0, "rdmExtensionType" : "StructuredDoc", "tenant" : { "id" : "-1", "creator" : "xdmAdmin", "modifier" : "xdmAdmin", "createTime" : "2024-11-13T08:27:59.903+0000", "lastUpdateTime" : "2024-11-13T08:27:59.903+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" : "StructuredDoc", "wikiId" : "a962e2d821c44bfdb65d33aa429c930uatwiki", "documentId" : "d24cad08-c0b2-449d-9dce-924392b67bf8", "instance" : { "id" : "1", "clazz" : "StructuredDocableModel", "className" : "StructuredDocableModel" }, "templateId" : null, "parentDocumentId" : "a962e2d821c44bfdb65d33aa429c930uatwiki", "organizationId" : "65cd6c5df4c84bdeb50dbfc7136cab7c", "type" : "pageDocument", "title" : "myTitle", "createUserId" : "93172bbfd0f64437956d4c9de9345386" }, "shareUserName" : "XDM_Developer", "sharedUserName" : "all", "sharedUserId" : "all", "authType" : "read", "shareUserId" : "93172bbfd0f64437956d4c9de9345386" } ], "errors" : [ ] }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 result String 参数解释： 请求结果。 取值范围： SUCCESS：请求成功。 FAIL：请求失败。 默认取值： 不涉及。 data Array of StructuredDocShareViewDTO objects 参数解释： 请求数据。 取值范围： 不涉及。 默认取值： 不涉及。 errors Array of strings 参数解释： 异常信息。 取值范围： 不涉及。 默认取值： 不涉及。 表5 StructuredDocShareViewDTO 参数 参数类型 描述 id String 参数解释： 唯一标识。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 creator String 参数解释： 创建者。 取值范围： 不涉及。 默认取值： 不涉及。 modifier String 参数解释： 修改人。 取值范围： 不涉及。 默认取值： 不涉及。 createTime String 参数解释： 创建时间。 取值范围： 不涉及。 默认取值： 不涉及。 lastUpdateTime String 参数解释： 最后更新时间。 取值范围： 不涉及。 默认取值： 不涉及。 rdmVersion Integer 参数解释： 系统版本。 取值范围： 不涉及。 默认取值： 不涉及。 rdmDeleteFlag Integer 参数解释： 软删除标识。 取值范围： 0：表示未删除。 1：表示已删除。 默认取值： 0。 rdmExtensionType String 参数解释： 扩展类型。 取值范围： 不涉及。 默认取值： 不涉及。 tenant TenantViewDTO object 参数解释： 租户信息。 取值范围： 不涉及。 默认取值： 不涉及。 className String 参数解释： 类名。 取值范围： 不涉及。 默认取值： 不涉及。 structuredDoc StructuredDocView object 参数解释： 结构化文档。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 shareUserName String 参数解释： 分享用户名。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 sharedUserName String 参数解释： 被分享用户名。 约束限制： 不涉及。 取值范围： all：表示所有人。 默认取值： 不涉及。 sharedUserId String 参数解释： 被分享用户UserId。 约束限制： 不涉及。 取值范围： all：表示所有人。 默认取值： 不涉及。 authType String 参数解释： 认证类型。 约束限制： 不涉及。 取值范围： read：只读。 write：读写。 默认取值： 不涉及。 shareUserId String 参数解释： 被分享用户UserId。 约束限制： 不涉及。 取值范围： all：表示所有人。 默认取值： 不涉及。 表6 StructuredDocView 参数 参数类型 描述 creator String 参数解释： 创建者。 取值范围： 不涉及。 默认取值： 不涉及。 createTime String 参数解释： 创建时间。 取值范围： 不涉及。 默认取值： 不涉及。 lastUpdateTime String 参数解释： 最后更新时间。 取值范围： 不涉及。 默认取值： 不涉及。 rdmVersion Integer 参数解释： 系统版本。 取值范围： 不涉及。 默认取值： 不涉及。 rdmDeleteFlag Integer 参数解释： 软删除标识，参数值为0或1。 取值范围： 0：表示未删除。 1：表示已删除。 默认取值： 不涉及。 rdmExtensionType String 参数解释： 扩展类型。 取值范围： 不涉及。 默认取值： 不涉及。 tenant TenantViewDTO object 参数解释： 租户信息。 取值范围： 不涉及。 默认取值： 不涉及。 className String 参数解释： 类名。 取值范围： 不涉及。 默认取值： 不涉及。 clazz String 参数解释： 类名。 取值范围： 不涉及。 默认取值： 不涉及。 id String 参数解释： 唯一标识。 取值范围： -9223372036854775808到9223372036854775807的整数。 默认取值： 不涉及。 document_id String 参数解释： kooPage文档ID。 取值范围： 不涉及。 默认取值： 不涉及。 title String 参数解释： 文档标题。 取值范围： 不涉及。 默认取值： 不涉及。 type String 参数解释： 文档类型。 取值范围： directory：目录。 pageDocument：Page文档。 boardDocument：Board文档。 mindDocument：Mind文档。 drawDocument：Draw文档。 默认取值： 不涉及。 template_id String 参数解释： 模板ID。 取值范围： 不涉及。 默认取值： 不涉及。 organization_id String 参数解释： 团队ID。 取值范围： 不涉及。 默认取值： 不涉及。 wiki_id String 参数解释： 知识库ID。 取值范围： 不涉及。 默认取值： 不涉及。 parent_document_id String 参数解释： 父文档ID。 取值范围： 不涉及。 默认取值： 不涉及。 instance_id String 参数解释： 实例ID。 取值范围： 不涉及。 默认取值： 不涉及。 model_name String 参数解释： 模型名称。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 create_user_id String 参数解释： 创建者ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 modifier 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 否 String 参数解释： 结构化文档ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

URI POST /rdm_{identifier}_app/publicservices/api/{modelName}/structured-doc/share-doc 表1 路径参数 参数 是否必选 参数类型 描述 modelName 是 String 参数解释： 数据模型的英文名称。 约束限制： 不涉及。 取值范围： 大写字母开头，只能包含字母、数字、“_”，且长度为[1-60]个字符。 默认取值： 不涉及。 identifier 是 String 参数解释： 应用唯一标识。 约束限制： 不涉及。 取值范围： 由英文字母和数字组成，且长度为32个字符。 默认取值： 不涉及。

响应示例 状态码：200 OK { "result" : "SUCCESS", "data" : [ { "id" : "123", "creator" : "test1", "modifier" : "XDM_Developer xxx", "createTime" : "2023-12-04T11:52:48.000+0000", "lastUpdateTime" : "2023-12-06T06:44:32.287+0000", "rdmVersion" : 3, "rdmDeleteFlag" : 0, "rdmExtensionType" : "PersistableModel", "tenant" : { "id" : "-1", "creator" : "xdmAdmin", "modifier" : "xdmAdmin", "createTime" : "2023-12-01T01:25:21.000+0000", "lastUpdateTime" : "2023-12-01T01:25:21.000+0000", "rdmVersion" : 1, "rdmDeleteFlag" : 0, "rdmExtensionType" : "Tenant", "tenant" : null, "className" : "Tenant", "name" : "basicTenant", "description" : "默认租户", "kiaguid" : null, "securityLevel" : "internal", "nameEn" : null, "code" : "basicTenant", "disableFlag" : false, "dataSource" : "DefaultDataSource" }, "className" : "PersistableModel", "uniqueKey" : "123" } ], "errors" : [ ] }

请求示例 POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/PersistableModel/updateByCondition { "applicationId" : "b3f9b7523a6141f4b2d76b92d6595281", "params" : { "condition" : { "characterSet" : "UTF8", "isNeedTotal" : true, "isPresentAll" : true, "publicData" : "INCLUDE_PUBLIC_DATA", "decrypt" : false, "filter" : { "joiner" : "and", "ignoreStr" : false, "conditions" : [ { "conditionName" : "id", "conditionValues" : [ "2" ], "operator" : "=", "ignoreStr" : false } ] }, "sorts" : [ ] }, "updateDTO" : { "modifier" : "test1", "creator" : "test1", "rdmExtensionType" : "PersistableModel", "uniqueKey" : "条件更新" } } }

响应参数 状态码：200 表10 响应Body参数 参数 参数类型 描述 result String 参数解释： 请求结果。 取值范围： SUCCESS：请求成功。 FAIL：请求失败。 默认取值： 不涉及。 data Array of PersistableModelViewDTO objects 参数解释： 请求数据。 取值范围： 不涉及。 默认取值： 不涉及。 errors Array of strings 参数解释： 异常信息。 取值范围： 不涉及。 默认取值： 不涉及。 表11 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 参数解释： 示例模型中定义的唯一键属性。 取值范围： 不涉及。 默认取值： 不涉及。 表12 TenantViewDTO 参数 参数类型 描述 className String 参数解释： 类名。 取值范围： 不涉及。 默认取值： 不涉及。 code String 参数解释： 租户编码。 取值范围： 不涉及。 默认取值： 不涉及。 createTime String 参数解释： 创建时间。 取值范围： 不涉及。 默认取值： 不涉及。 creator String 参数解释： 创建者。 取值范围： 不涉及。 默认取值： 不涉及。 dataSource String 参数解释： 租户使用的数据源名称。 取值范围： 不涉及。 默认取值： 不涉及。 description String 参数解释： 描述信息。 取值范围： 不涉及。 默认取值： 不涉及。 disableFlag Boolean 参数解释： 失效标识。 取值范围： true：失效。 false：未失效。 默认取值： false。 id String 参数解释： 唯一标识。 取值范围： -9223372036854775808到9223372036854775807的整数。 默认取值： 不涉及。 kiaguid String 参数解释： KIA密级。 取值范围： 不涉及。 默认取值： 不涉及。 lastUpdateTime String 参数解释： 最后更新时间。 取值范围： 不涉及。 默认取值： 不涉及。 modifier String 参数解释： 修改人。 取值范围： 不涉及。 默认取值： 不涉及。 name String 参数解释： 中文名称。 取值范围： 不涉及。 默认取值： 不涉及。 rdmDeleteFlag Integer 参数解释： 软删除标识。 取值范围： 0：表示未删除。 1：表示已删除。 默认取值： 0。 rdmExtensionType String 参数解释： 扩展类型。 取值范围： 不涉及。 默认取值： 不涉及。 rdmVersion Integer 参数解释： 系统版本。 取值范围： 不涉及。 默认取值： 不涉及。 securityLevel String 参数解释： 安全密级。 取值范围： INTERNAL：内部公开。 SECRET：秘密。 CONFIDENTIAL：机密。 TOP_SECRET：绝密。 默认取值： 不涉及。 tenant TenantViewDTO object 参数解释： 租户信息。 取值范围： 不涉及。 默认取值： 不涉及。

URI POST /rdm_{identifier}_app/publicservices/api/{modelName}/updateByCondition 表1 路径参数 参数 是否必选 参数类型 描述 identifier 是 String 参数解释： 应用唯一标识。 约束限制： 不涉及。 取值范围： 由英文字母和数字组成，且长度为32个字符。 默认取值： 不涉及。 modelName 是 String 参数解释： 数据模型的英文名称。 约束限制： 不涉及。 取值范围： 大写字母开头，只能包含字母、数字、“_”，且长度为[1-60]个字符。 默认取值： 不涉及。

请求示例 POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/StructuredDocableModel/structured-doc/documents/query { "params" : { "instance_id" : "1" } }

响应示例 状态码：200 OK { "result" : "SUCCESS", "data" : [ { "creator" : "XDM_Developer 93172bbfd0f64437956d4c9de9345386", "createTime" : "2025-01-15T06:28:59.147+0000", "lastUpdateTime" : "2025-01-15T06:28:59.147+0000", "rdmVersion" : 3, "rdmDeleteFlag" : 0, "rdmExtensionType" : "StructuredDoc", "tenant" : { "id" : "-1", "creator" : "xdmAdmin", "modifier" : "xdmAdmin", "createTime" : "2024-11-13T08:27:59.903+0000", "lastUpdateTime" : "2024-11-13T08:27:59.903+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" : "StructuredDoc", "clazz" : "StructuredDoc", "id" : "721008152111222784", "document_id" : "19619ac0-22ee-405a-bf35-53673efa3267", "title" : "myTilte2", "type" : "pageDocument", "template_id" : null, "organization_id" : "65cd6c5df4c84bdeb50dbfc7136cab7c", "wiki_id" : "a962e2d821c44bfdb65d33aa429c930uatwiki", "parent_document_id" : "720941361796222976", "instance_id" : "1", "model_name" : "StructuredDocableModel", "create_user_id" : "93172bbfd0f64437956d4c9de9345386", "modifier" : "XDM_Developer 93172bbfd0f64437956d4c9de9345386" } ], "errors" : [ ] }

响应参数 状态码：200 表5 响应Body参数 参数 参数类型 描述 result String 参数解释： 请求结果。 取值范围： SUCCESS：请求成功。 FAIL：请求失败。 默认取值： 不涉及。 data Array of StructuredDocView objects 参数解释： 请求数据。 取值范围： 不涉及。 默认取值： 不涉及。 errors Array of strings 参数解释： 异常信息。 取值范围： 不涉及。 默认取值： 不涉及。 表6 StructuredDocView 参数 参数类型 描述 creator String 参数解释： 创建者。 取值范围： 不涉及。 默认取值： 不涉及。 createTime String 参数解释： 创建时间。 取值范围： 不涉及。 默认取值： 不涉及。 lastUpdateTime String 参数解释： 最后更新时间。 取值范围： 不涉及。 默认取值： 不涉及。 rdmVersion Integer 参数解释： 系统版本。 取值范围： 不涉及。 默认取值： 不涉及。 rdmDeleteFlag Integer 参数解释： 软删除标识，参数值为0或1。 取值范围： 0：表示未删除。 1：表示已删除。 默认取值： 不涉及。 rdmExtensionType String 参数解释： 扩展类型。 取值范围： 不涉及。 默认取值： 不涉及。 tenant TenantViewDTO object 参数解释： 租户信息。 取值范围： 不涉及。 默认取值： 不涉及。 className String 参数解释： 类名。 取值范围： 不涉及。 默认取值： 不涉及。 clazz String 参数解释： 类名。 取值范围： 不涉及。 默认取值： 不涉及。 id String 参数解释： 唯一标识。 取值范围： -9223372036854775808到9223372036854775807的整数。 默认取值： 不涉及。 document_id String 参数解释： kooPage文档ID。 取值范围： 不涉及。 默认取值： 不涉及。 title String 参数解释： 文档标题。 取值范围： 不涉及。 默认取值： 不涉及。 type String 参数解释： 文档类型。 取值范围： directory：目录。 pageDocument：Page文档。 boardDocument：Board文档。 mindDocument：Mind文档。 drawDocument：Draw文档。 默认取值： 不涉及。 template_id String 参数解释： 模板ID。 取值范围： 不涉及。 默认取值： 不涉及。 organization_id String 参数解释： 团队ID。 取值范围： 不涉及。 默认取值： 不涉及。 wiki_id String 参数解释： 知识库ID。 取值范围： 不涉及。 默认取值： 不涉及。 parent_document_id String 参数解释： 父文档ID。 取值范围： 不涉及。 默认取值： 不涉及。 instance_id String 参数解释： 实例ID。 取值范围： 不涉及。 默认取值： 不涉及。 model_name String 参数解释： 模型名称。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 create_user_id String 参数解释： 创建者ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 modifier 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 否 QueryDocParamDto object 参数解释： 请求参数对象。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表4 QueryDocParamDto 参数 是否必选 参数类型 描述 instance_id 否 String 参数解释： 实例ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 type 否 String 参数解释： 文档类型。 约束限制： 不涉及。 取值范围： directory：目录。 pageDocument：Page文档。 boardDocument：Board文档。 mindDocument：Mind文档。 drawDocument：Draw文档。 默认取值： 不涉及。

URI POST /rdm_{identifier}_app/publicservices/api/{modelName}/structured-doc/documents/query 表1 路径参数 参数 是否必选 参数类型 描述 modelName 是 String 参数解释： 数据模型的英文名称。 约束限制： 不涉及。 取值范围： 大写字母开头，只能包含字母、数字、“_”，且长度为[1-60]个字符。 默认取值： 不涉及。 identifier 是 String 参数解释： 应用唯一标识。 约束限制： 不涉及。 取值范围： 由英文字母和数字组成，且长度为32个字符。 默认取值： 不涉及。

响应参数 状态码：200 表9 响应Body参数 参数 参数类型 描述 result String 参数解释： 请求结果。 取值范围： SUCCESS：请求成功。 FAIL：请求失败。 默认取值： 不涉及。 data Array of PersistableModelListViewDTO objects 参数解释： 请求数据。 取值范围： 不涉及。 默认取值： 不涉及。 errors Array of strings 参数解释： 异常信息。 取值范围： 不涉及。 默认取值： 不涉及。 表10 PersistableModelListViewDTO 参数 参数类型 描述 aclEntry String 参数解释： 访问控制列表。 取值范围： 不涉及。 默认取值： 不涉及。 className String 参数解释： 类名。 取值范围： 不涉及。 默认取值： 不涉及。 clsAttrs Array of objects 参数解释： 分类属性。 取值范围： 不涉及。 默认取值： 不涉及。 createTime String 参数解释： 创建时间。 取值范围： 不涉及。 默认取值： 不涉及。 creator String 参数解释： 创建者。 取值范围： 不涉及。 默认取值： 不涉及。 disableFlag Boolean 参数解释： 失效标识。 取值范围： true：失效。 false：未失效。 默认取值： 不涉及。 folder ObjectReferenceViewDTO object 参数解释： 文件夹。 取值范围： 不涉及。 默认取值： 不涉及。 fullPath String 参数解释： 用于存储当前节点全路径。 取值范围： 不涉及。 默认取值： 不涉及。 id String 参数解释： 唯一标识。 取值范围： -9223372036854775808到9223372036854775807的整数。 默认取值： 不涉及。 lastUpdateTime String 参数解释： 最后更新时间。 取值范围： 不涉及。 默认取值： 不涉及。 leafFlag Boolean 参数解释： 是否为叶子节点。 取值范围： true：是叶子节点。 false：不是叶子节点。 默认取值： false。 lifecycleState ObjectReferenceViewDTO object 参数解释： 状态 取值范围： 不涉及。 默认取值： 不涉及。 lifecycleTemplate ObjectReferenceViewDTO object 参数解释： 生命周期模板。 取值范围： 不涉及。 默认取值： 不涉及。 modifier String 参数解释： 更新者。 取值范围： 不涉及。 默认取值： 不涉及。 owner String 参数解释： 拥有者。 取值范围： 不涉及。 默认取值： 不涉及。 parentNode ObjectReferenceViewDTO object 参数解释： 父节点。 取值范围： 不涉及。 默认取值： 不涉及。 rawFullPath String 参数解释： 用于存储当前节点原始全路径。 取值范围： 不涉及。 默认取值： 不涉及。 rdmDeleteFlag Integer 参数解释： 软删除标识。 取值范围： 0：表示未删除。 1：表示已删除。 默认取值： 0。 rdmExtensionType String 参数解释： 扩展类型。 取值范围： 不涉及。 默认取值： 不涉及。 rdmVersion Integer 参数解释： 系统版本。 取值范围： 不涉及。 默认取值： 不涉及。 rootNode ObjectReferenceViewDTO object 参数解释： 根节点。 取值范围： 不涉及。 默认取值： 不涉及。 tenant ObjectReferenceViewDTO object 参数解释： 租户信息。 取值范围： 不涉及。 默认取值： 不涉及。 uniqueKey String 参数解释： 示例模型的唯一键约束属性。 取值范围： 不涉及。 默认取值： 不涉及。 表11 ObjectReferenceViewDTO 参数 参数类型 描述 clazz String 参数解释： 类名。 取值范围： 不涉及。 默认取值： 不涉及。 id String 参数解释： 唯一标识。 约束限制： 不涉及。 取值范围： -9223372036854775808到9223372036854775807的整数。 默认取值： 不涉及。

请求示例 POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/PersistableModel/list/10/1 { "applicationId" : "b3f9b7523a6141f4b2d76b92d6595281", "params" : { "characterSet" : "UTF8", "isNeedTotal" : true, "isPresentAll" : true, "publicData" : "INCLUDE_PUBLIC_DATA", "decrypt" : false, "filter" : { "joiner" : "and", "ignoreStr" : false, "conditions" : [ { "conditionName" : "rdmExtensionType", "conditionValues" : [ "PersistableModel" ], "operator" : "=", "ignoreStr" : false } ] }, "sorts" : [ ] } }

响应示例 状态码：200 OK { "result" : "SUCCESS", "data" : [ { "aclEntry" : "AclEntry", "className" : "PersistableModel", "clsAttrs" : [ ], "createTime" : "2023-09-27T06:18:03.000+0000", "creator" : "test1", "disableFlag" : false, "folder" : { "clazz" : "PersistableModel", "id" : "548451844855177200" }, "fullPath" : "/*/*/**", "id" : "548451844855177200", "lastUpdateTime" : "2023-09-27T06:18:03.000+0000", "leafFlag" : false, "lifecycleState" : { "clazz" : "PersistableModel", "id" : "548451844855177200" }, "lifecycleTemplate" : { "clazz" : "PersistableModel", "id" : "548451844855177200" }, "modifier" : "test1", "owner" : "test1", "parentNode" : { "clazz" : "PersistableModel", "id" : "548451844855177200" }, "rawFullPath" : "/**/**", "rdmDeleteFlag" : 0, "rdmExtensionType" : "PersistableModel", "rdmVersion" : 1, "rootNode" : { "clazz" : "PersistableModel", "id" : "548451844855177200" }, "tenant" : { "clazz" : "PersistableModel", "id" : "548451844855177200" }, "uniqueKey" : "id" } ], "errors" : [ ] }

URI POST /rdm_{identifier}_app/publicservices/api/{modelName}/list/{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。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释： IAM用户的token。 获取方法请参见获取IAM用户Token。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 applicationId 否 String 参数解释： 应用ID。 约束限制： 不涉及。 取值范围： 由英文字母和数字组成，且长度为32个字符。 默认取值： 不涉及。 params 否 PersistObjectIdsDTO object 参数解释： 请求参数对象。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表4 PersistObjectIdsDTO 参数 是否必选 参数类型 描述 ids 是 Array of strings 参数解释： 数据实例 ID列表。 约束限制： 不涉及。 取值范围： -9223372036854775808到9223372036854775807的整数。 默认取值： 不涉及。

响应参数 状态码：200 表5 响应Body参数 参数 参数类型 描述 result String 参数解释： 请求结果。 取值范围： SUCCESS：请求成功。 FAIL：请求失败。 默认取值： 不涉及。 data Array of integers 参数解释： 请求数据。 取值范围： 不涉及。 默认取值： 不涉及。 errors Array of strings 参数解释： 异常信息。 取值范围： 不涉及。 默认取值： 不涉及。

请求示例 DELETE https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/StructuredDocableModel/structured-doc/share-doc/batch { "params" : { "ids" : [ "721366695490363392" ] } }

URI DELETE /rdm_{identifier}_app/publicservices/api/{modelName}/structured-doc/share-doc/batch 表1 路径参数 参数 是否必选 参数类型 描述 modelName 是 String 参数解释： 数据模型的英文名称。 约束限制： 不涉及。 取值范围： 大写字母开头，只能包含字母、数字、“_”，且长度为[1-60]个字符。 默认取值： 不涉及。 identifier 是 String 参数解释： 应用唯一标识。 约束限制： 不涉及。 取值范围： 由英文字母和数字组成，且长度为32个字符。 默认取值： 不涉及。

请求示例 POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/PersistableModel/deleteByCondition { "applicationId" : "b3f9b7523a6141f4b2d76b92d6595281", "params" : { "condition" : { "characterSet" : "UTF8", "isNeedTotal" : true, "isPresentAll" : true, "publicData" : "INCLUDE_PUBLIC_DATA", "decrypt" : false, "filter" : { "joiner" : "and", "ignoreStr" : false, "conditions" : [ { "conditionName" : "id", "conditionValues" : [ "666" ], "operator" : "=", "ignoreStr" : false } ] }, "sorts" : [ ] }, "modifier" : "test1" } }

响应参数 状态码：200 表9 响应Body参数 参数 参数类型 描述 result String 参数解释： 请求结果。 取值范围： SUCCESS：请求成功。 FAIL：请求失败。 默认取值： 不涉及。 data Array of longs 参数解释： 请求操作数据数量。 取值范围： 不涉及。 默认取值： 不涉及。 errors Array of strings 参数解释： 异常信息。 取值范围： 不涉及。 默认取值： 不涉及。

URI POST /rdm_{identifier}_app/publicservices/api/{modelName}/deleteByCondition 表1 路径参数 参数 是否必选 参数类型 描述 identifier 是 String 参数解释： 应用唯一标识。 约束限制： 不涉及。 取值范围： 由英文字母和数字组成，且长度为32个字符。 默认取值： 不涉及。 modelName 是 String 参数解释： 数据模型的英文名称。 约束限制： 不涉及。 取值范围： 大写字母开头，只能包含字母、数字、“_”，且长度为[1-60]个字符。 默认取值： 不涉及。

URI POST /rdm_{identifier}_app/publicservices/api/{modelName}/logicalDeleteByCondition 表1 路径参数 参数 是否必选 参数类型 描述 identifier 是 String 参数解释： 应用唯一标识。 约束限制： 不涉及。 取值范围： 由英文字母和数字组成，且长度为32个字符。 默认取值： 不涉及。 modelName 是 String 参数解释： 数据模型的英文名称。 约束限制： 不涉及。 取值范围： 大写字母开头，只能包含字母、数字、“_”，且长度为[1-60]个字符。 默认取值： 不涉及。

响应参数 状态码：200 表9 响应Body参数 参数 参数类型 描述 result String 参数解释： 请求结果。 取值范围： SUCCESS：请求成功。 FAIL：请求失败。 默认取值： 不涉及。 data Array of longs 参数解释： 请求操作数据数量。 取值范围： 不涉及。 默认取值： 不涉及。 errors Array of strings 参数解释： 异常信息。 取值范围： 不涉及。 默认取值： 不涉及。