查询结构化文档
功能介绍
查询结构化文档。
接口约束
功能列表勾选了结构化文档管理的模型可以使用该接口。
URI
POST /rdm_{identifier}_app/publicservices/api/{modelName}/structured-doc/documents/query
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
modelName |
是 |
String |
参数解释： 数据模型的英文名称。 约束限制： 不涉及。 取值范围： 大写字母开头，只能包含字母、数字、“_”，且长度为[1-60]个字符。 默认取值： 不涉及。 |
|
identifier |
是 |
String |
参数解释： 应用唯一标识。 约束限制： 不涉及。 取值范围： 由英文字母和数字组成，且长度为32个字符。 默认取值： 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释： IAM用户的token。 获取方法请参见获取IAM用户Token。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
applicationId |
否 |
String |
参数解释： 应用ID。 约束限制： 不涉及。 取值范围： 由英文字母和数字组成，且长度为32个字符。 默认取值： 不涉及。 |
|
params |
否 |
QueryDocParamDto object |
参数解释： 请求参数对象。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
result |
String |
参数解释： 请求结果。 取值范围：
默认取值： 不涉及。 |
|
data |
Array of StructuredDocView objects |
参数解释： 请求数据。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
errors |
Array of strings |
参数解释： 异常信息。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
creator |
String |
参数解释： 创建者。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
createTime |
String |
参数解释： 创建时间。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
lastUpdateTime |
String |
参数解释： 最后更新时间。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
rdmVersion |
Integer |
参数解释： 系统版本。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
rdmDeleteFlag |
Integer |
参数解释： 软删除标识，参数值为0或1。 取值范围：
默认取值： 不涉及。 |
|
rdmExtensionType |
String |
参数解释： 扩展类型。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
tenant |
TenantViewDTO object |
参数解释： 租户信息。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
className |
String |
参数解释： 类名。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
clazz |
String |
参数解释： 类名。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
id |
String |
参数解释： 唯一标识。 取值范围： -9223372036854775808到9223372036854775807的整数。 默认取值： 不涉及。 |
|
document_id |
String |
参数解释： kooPage文档ID。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
title |
String |
参数解释： 文档标题。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
type |
String |
参数解释： 文档类型。 取值范围：
默认取值： 不涉及。 |
|
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 |
参数解释： 修改人。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
className |
String |
参数解释： 类名。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
code |
String |
参数解释： 租户编码。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
createTime |
String |
参数解释： 创建时间。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
creator |
String |
参数解释： 创建者。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
dataSource |
String |
参数解释： 租户使用的数据源名称。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
description |
String |
参数解释： 描述信息。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
disableFlag |
Boolean |
参数解释： 失效标识。 取值范围：
默认取值： false。 |
|
id |
String |
参数解释： 唯一标识。 取值范围： -9223372036854775808到9223372036854775807的整数。 默认取值： 不涉及。 |
|
kiaguid |
String |
参数解释： KIA密级。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
lastUpdateTime |
String |
参数解释： 最后更新时间。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
modifier |
String |
参数解释： 修改人。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
name |
String |
参数解释： 中文名称。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
rdmDeleteFlag |
Integer |
参数解释： 软删除标识。 取值范围：
默认取值： 0。 |
|
rdmExtensionType |
String |
参数解释： 扩展类型。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
rdmVersion |
Integer |
参数解释： 系统版本。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
securityLevel |
String |
参数解释： 安全密级。 取值范围：
默认取值： 不涉及。 |
|
tenant |
TenantViewDTO object |
参数解释： 租户信息。 取值范围： 不涉及。 默认取值： 不涉及。 |
请求示例
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 |
OK |
错误码
请参见错误码。
