分页查询协作空间目录资料内容
接口说明
对应空间 list-resources。有效成员按目录可见范围查询直属子目录及资料,统一分页、目录优先,包含只读引用。省略目录/root 时沿用既有根初始化。sourceTypes 有值只返回资料;sourceStatus 沿用物理目录保留、直属引用目录不返回的既有行为。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST /openapi/listGroupDirectory HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| tenantId |
string |
否 |
租户 ID,公共参数;缺省时使用调用方默认租户 |
10000 |
| groupId |
string |
是 |
协作空间 ID |
group_example |
| directoryId |
string |
否 |
空间内可见目录 ID;省略或 root 查内部根,首次查询沿用现有服务初始化根目录 |
dir_example |
| page |
integer |
否 |
页码,从 1 开始 |
1 |
| pageSize |
integer |
否 |
每页数量,1..100,默认 20 |
20 |
| sortField |
string |
否 |
组内排序字段:name、gmt_create、gmt_modified;目录优先 |
name |
| sortOrder |
string |
否 |
组内排序方向:asc 或 desc;目录始终优先 |
asc |
| sourceTypes |
array |
否 |
资源类型数组;有值时仅返回资源,空数组或省略不按类型筛选,沿用现有资料类型筛选逻辑 |
["TEXT"] |
|
string |
否 |
单个资源类型值,如 TEXT |
TEXT |
|
| sourceStatus |
string |
否 |
资源状态筛选;物理子目录仍保留,直属引用目录在设置状态筛选时不返回,沿用现有行为 |
READY |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| code |
string |
业务状态码,成功为 200 |
200 |
| message |
string |
错误描述 |
请求的资源不存在 |
| requestId |
string |
请求追踪 ID |
019FF406-1B10-0065-A97D-2D1920C2A03D |
| items |
array<object> |
当前页直属子目录与资料,不包含查询目录自身,不递归展开 |
[] |
|
array<object> |
|||
| itemType |
string |
内容类型:directory 子目录或 resource 资料 |
resource |
| itemId |
string |
目录的 directoryId 或资料的 sourceId |
source_example |
| name |
string |
内容名称 |
项目资料 |
| gmtCreate |
integer |
创建时间戳,秒 |
1 |
| gmtModified |
integer |
修改时间戳,秒 |
1 |
| sourceType |
string |
资料类型,资源项有值;沿用服务的类型展示规则 |
example |
| sourceStatus |
string |
资料解析状态,资源项有值 |
READY |
| directoryType |
string |
目录类型;空间物理目录为 GROUP,引用目录保留原类型 |
example |
| directoryKind |
string |
目录归属分类,沿用服务输出,如 normal |
example |
| sourceKind |
string |
资料归属分类,沿用服务输出 |
example |
| objectBindings |
array<object> |
资源对象绑定列表,元数据缺失或引用资料可能为空 |
[] |
|
object |
|||
| graphName |
string |
绑定所属图谱名称 |
example |
| objectType |
string |
对象类型 |
example |
| objectId |
string |
对象业务 ID |
example |
| objectName |
string |
对象显示名 |
example |
| objectTypeName |
string |
对象类型显示名 |
example |
| creatorName |
string |
目录创建人或资料提交人姓名 |
example |
| modifierName |
string |
最近修改人姓名 |
example |
| readOnly |
boolean |
是否为只读引用内容;false 不代表具备写权限,写入仍需创建者或空间管理员权限 |
false |
| totalCount |
integer |
筛选后分页前总数,包含命中的物理内容与引用内容 |
10 |
| page |
integer |
当前页码 |
1 |
| pageSize |
integer |
每页数量 |
20 |
示例
正常返回示例
JSON格式
{
"code": "200",
"message": "请求的资源不存在",
"requestId": "019FF406-1B10-0065-A97D-2D1920C2A03D",
"items": [
{
"itemType": "resource",
"itemId": "source_example",
"name": "项目资料",
"gmtCreate": 1,
"gmtModified": 1,
"sourceType": "example",
"sourceStatus": "READY",
"directoryType": "example",
"directoryKind": "example",
"sourceKind": "example",
"objectBindings": [
{
"graphName": "example",
"objectType": "example",
"objectId": "example",
"objectName": "example",
"objectTypeName": "example"
}
],
"creatorName": "example",
"modifierName": "example",
"readOnly": false
}
],
"totalCount": 10,
"page": 1,
"pageSize": 20
}