查询结构化文档 - ListQueryDocuments

identifier

是

String

参数解释：

应用的唯一标识。

• 于2023年06月01日之前创建的应用，其唯一标识为该应用的名称。

• 于2023年06月01日之后创建的应用，其唯一标识为该应用的ID。

获取方法请参见获取运行服务清单 - ListEnvs。

约束限制：

不涉及。

取值范围：

• 于2023年06月01日之前创建的应用：由英文字母和数字组成，长度为1-36个字符。

• 于2023年06月01日之后创建的应用：由英文字母和数字组成，且长度为32个字符。

默认取值：

不涉及。

modelName

是

String

参数解释：

数据模型的英文名称。

约束限制：

不涉及。

取值范围：

以大写字母开头，只能包含字母、数字、“_”，且长度为1-60个字符。

默认取值：

不涉及。

X-Auth-Token

是

String

参数解释：

IAM用户的token。

获取方法请参见获取IAM用户Token。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

applicationId

否

String

参数解释：

应用ID，用于指定实例所属的应用。

当URL路径中已能明确应用上下文时，此参数可不传。

获取方法请参见获取租户下的应用清单 - ListApps。

约束限制：

不涉及。

取值范围：

• 于2023年06月01日之前创建的应用：由英文字母和数字组成，长度为1-36个字符。

• 于2023年06月01日之后创建的应用：由英文字母和数字组成，且长度为32个字符。

默认取值：

不涉及。

params

是

QueryDocParamDto object

参数解释：

请求参数对象，用于指定结构化文档的筛选条件。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

否

String

参数解释：

实例ID，用于筛选与指定数据模型实例关联的结构化文档。

例如查询某产品实例下的所有设计文档。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

type

否

String

参数解释：

文档类型，用于筛选指定类型的结构化文档。

约束限制：

不涉及。

取值范围：

• directory：目录，用于组织和管理文档层级结构。

• pageDocument：Page文档，适用于富文本编辑场景，如设计说明书、技术文档等。

• boardDocument：Board文档，适用于白板协作场景，如工艺评审、方案讨论等。

• mindDocument：Mind文档，适用于思维导图场景，如产品结构分析、流程梳理等。

• drawDocument：Draw文档，适用于绘图场景，如工艺流程图、设备布局图等。

默认取值：

不涉及。

result

String

参数解释：

请求处理结果状态。

取值范围：

• SUCCESS：请求成功。

• FAIL：请求失败。

data

Array of StructuredDocView objects

参数解释：

请求数据，返回符合条件的结构化文档列表。

取值范围：

不涉及。

errors

Array of strings

参数解释：

异常信息列表。当result为FAIL时，返回具体的错误描述，包含失败原因及建议处理方式。

取值范围：

不涉及。

creator

String

参数解释：

创建者账号，标识创建该文档的用户。

取值范围：

不涉及。

createTime

String

参数解释：

创建时间。使用UTC+0时间格式，格式为yyyy-MM-ddTHH:mm:ss.SSSZ。

取值范围：

不涉及。

lastUpdateTime

String

参数解释：

最后更新时间。使用UTC+0时间格式，格式为yyyy-MM-ddTHH:mm:ss.SSSZ。

取值范围：

不涉及。

rdmVersion

Integer

参数解释：

系统版本号，用于数据版本控制。

取值范围：

不涉及。

rdmDeleteFlag

Integer

参数解释：

软删除标识。

取值范围：

• 0：表示未删除。

• 1：表示已删除。

rdmExtensionType

String

参数解释：

扩展类型，标识对象的扩展类别。

取值范围：

不涉及。

tenant

TenantViewDTO object

参数解释：

租户信息，包含文档所属租户的详细信息。

取值范围：

不涉及。

className

String

参数解释：

类名，标识对象的Java类名称。

取值范围：

不涉及。

clazz

String

参数解释：

类名，标识对象的类类型。

取值范围：

不涉及。

id

String

参数解释：

唯一标识，系统生成的文档主键ID。

取值范围：

-9223372036854775808到9223372036854775807的整数。

document_id

String

参数解释：

KooPage文档ID，系统生成的KooPage文档唯一标识。

取值范围：

不涉及。

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

ObjectReferenceViewDTO object

参数解释：

实体实例，标识文档关联的数据模型实例信息。

取值范围：

不涉及。

model_name

String

参数解释：

模型名称，标识文档关联的数据模型名称。

取值范围：

不涉及。

create_user_id

String

参数解释：

创建者ID，标识创建该文档的用户ID。

取值范围：

不涉及。

modifier

String

参数解释：

更新者账号，标识最后更新该文档的用户。

取值范围：

不涉及。

className

String

参数解释：

租户对象的类名。

取值范围：

不涉及。

code

String

参数解释：

租户编码，用于多租户场景下的租户唯一标识。

取值范围：

不涉及。

createTime

String

参数解释：

租户对象的创建时间。使用UTC+0时间格式，格式为yyyy-MM-ddTHH:mm:ss.SSSZ。

取值范围：

不涉及。

creator

String

参数解释：

租户对象的创建者账号。

取值范围：

不涉及。

dataSource

String

参数解释：

租户使用的数据源名称，用于多租户数据隔离。

取值范围：

不涉及。

description

String

参数解释：

租户描述信息。

取值范围：

不涉及。

disableFlag

Boolean

参数解释：

租户失效标识，用于标识租户是否已失效。

取值范围：

• true：失效。

• false：未失效（默认）。

id

String

参数解释：

租户的唯一标识。

取值范围：

-9223372036854775808到9223372036854775807的整数。

kiaguid

String

参数解释：

租户KIA密级。

取值范围：

不涉及。

lastUpdateTime

String

参数解释：

租户的最后更新时间。使用UTC+0时间格式，格式为yyyy-MM-ddTHH:mm:ss.SSSZ。

取值范围：

不涉及。

modifier

String

参数解释：

租户的更新者账号。

取值范围：

不涉及。

name

String

参数解释：

租户中文名称。

取值范围：

不涉及。

nameEn

String

参数解释：

租户英文名称。

取值范围：

不涉及。

rdmDeleteFlag

Integer

参数解释：

软删除标识。

取值范围：

• 0：表示未删除。

• 1：表示已删除。

rdmExtensionType

String

参数解释：

租户扩展类型。

取值范围：

不涉及。

rdmVersion

Integer

参数解释：

租户对象的系统版本号。

取值范围：

不涉及。

securityLevel

String

参数解释：

租户安全密级，用于标识租户信息的安全等级。

取值范围：

• internal：内部公开。

• secret：秘密。

• confidential：机密。

• top_secret：绝密。

tenant

TenantViewDTO object

参数解释：

租户信息，表示当前租户的父租户信息。

取值范围：

不涉及。

id

String

参数解释：

唯一标识，标识关联实例的主键ID。

clazz

String

参数解释：

类名，标识关联实例的类类型。

200

OK，表示请求成功。