查询结构化文档分享授权列表 - ListQueryShareDocs

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

是

String

参数解释：

结构化文档ID，系统生成的文档主键唯一标识，用于指定待查询分享授权列表的目标文档。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

result

String

参数解释：

请求处理结果状态。

取值范围：

• SUCCESS：请求成功。

• FAIL：请求失败。

data

Array of StructuredDocShareViewDTO objects

参数解释：

请求数据，返回目标结构化文档的分享授权记录列表。

每条记录包含分享人、被分享人、权限类型等详细信息。

取值范围：

不涉及。

errors

Array of strings

参数解释：

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

取值范围：

不涉及。

id

String

参数解释：

分享权限记录的唯一标识，可用于批量删除分享权限接口定位目标记录。

取值范围：

不涉及。

creator

String

参数解释：

创建者账号，标识创建该分享记录的用户。

取值范围：

不涉及。

modifier

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类名称。

取值范围：

不涉及。

structuredDoc

StructuredDocViewDTO object

参数解释：

结构化文档信息，包含被分享文档的详细信息。

取值范围：

不涉及。

shareUserName

String

参数解释：

分享用户名，标识执行分享操作的用户名称。

取值范围：

不涉及。

sharedUserName

String

参数解释：

被分享用户名，标识接收文档分享的用户名称。

取值范围：

• all：表示分享给所有人。

• 其他值：指定具体用户的名称。

sharedUserId

String

参数解释：

被分享用户ID，标识接收文档分享的用户ID。

取值范围：

• all：表示分享给所有人。

• 其他值：指定具体用户的ID。

authType

String

参数解释：

认证类型，标识被分享用户对文档的访问权限级别。

取值范围：

• read：只读权限，被分享用户仅可查看文档内容。

• write：读写权限，被分享用户可查看和编辑文档内容。

shareUserId

String

参数解释：

分享用户ID，标识执行分享操作的用户ID。

取值范围：

不涉及。

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的整数。

documentId

String

参数解释：

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

取值范围：

不涉及。

title

String

参数解释：

文档标题。

取值范围：

不涉及。

type

String

参数解释：

文档类型。

取值范围：

• directory：目录。

• pageDocument：Page文档。

• boardDocument：Board文档。

• mindDocument：Mind文档。

• drawDocument：Draw文档。

templateId

String

参数解释：

模板ID。

取值范围：

不涉及。

organizationId

String

参数解释：

团队ID。

取值范围：

不涉及。

wikiId

String

参数解释：

知识库ID。

取值范围：

不涉及。

parentDocumentId

String

参数解释：

父文档ID，标识该文档所属的父级目录。

取值范围：

不涉及。

instance

ObjectReferenceViewDTO object

参数解释：

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

取值范围：

不涉及。

createUserId

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，表示请求成功。