Skip to content

分页查询文档

POST
/v1/documents/getPage

授权

apiKey
类型
API Key (header: Authorization)

参数

请求头参数

X-Atk-User-Token

强通道:系统自签的不透明用户会话 token,用于 Client 代表用户调用。 与 X-Atk-Act-As-Source / X-Atk-Act-As-Source-Id 互斥,同时携带服务端返回 400 INVALID_DELEGATION_HEADERS。

类型
string
X-Atk-Act-As-Source

弱通道:身份 source 主张(要求 Client 已开启 actAsAllowed)。 必须与 X-Atk-Act-As-Source-Id 成对携带,缺一服务端返回 400 INCOMPLETE_ACT_AS_HEADERS;与 X-Atk-User-Token 互斥,同时携带服务端返回 400 INVALID_DELEGATION_HEADERS。

类型
string
X-Atk-Act-As-Source-Id

弱通道:身份 sourceId 主张(要求 Client 已开启 actAsAllowed)。 必须与 X-Atk-Act-As-Source 成对携带,缺一服务端返回 400 INCOMPLETE_ACT_AS_HEADERS;与 X-Atk-User-Token 互斥,同时携带服务端返回 400 INVALID_DELEGATION_HEADERS。

类型
string

请求体

application/json
JSON
{
  
"pageSize": 0,
  
"pageNumber": 0,
  
"orderByColumn": "string",
  
"isAsc": "string",
  
"containerId": "string",
  
"containerNameLike": "string",
  
"documentTypeId": "string",
  
"state": "string",
  
"metadataFilters": [
  
  
{
  
  
  
"attributeKey": "department",
  
  
  
"operator": "EQ",
  
  
  
"value": {
  
  
  
},
  
  
  
"values": [
  
  
  
  
{
  
  
  
  
}
  
  
  
],
  
  
  
"rangeFrom": {
  
  
  
},
  
  
  
"rangeTo": {
  
  
  
}
  
  
}
  
]
}

响应

OK

*/*
JSON
{
  
"code": 0,
  
"data": {
  
  
"totalElements": 0,
  
  
"content": [
  
  
  
{
  
  
  
  
"docId": "string",
  
  
  
  
"containerId": "string",
  
  
  
  
"containerName": "string",
  
  
  
  
"title": "string",
  
  
  
  
"documentTypeId": "string",
  
  
  
  
"documentTypeName": "string",
  
  
  
  
"currentVersionId": "string",
  
  
  
  
"state": "string",
  
  
  
  
"publishedVersionId": "string",
  
  
  
  
"publishedVersionNo": 0,
  
  
  
  
"publishedLabel": "string",
  
  
  
  
"createBy": "string",
  
  
  
  
"createByName": "string",
  
  
  
  
"sizeBytes": 0,
  
  
  
  
"mimeType": "string",
  
  
  
  
"originalFilename": "string",
  
  
  
  
"currentVersionNo": 0,
  
  
  
  
"createTime": "string",
  
  
  
  
"updateTime": "string",
  
  
  
  
"indexStatus": "string",
  
  
  
  
"indexFailReason": "string",
  
  
  
  
"purgeAt": "string",
  
  
  
  
"metadataColumns": {
  
  
  
  
  
"additionalProperties": {
  
  
  
  
  
}
  
  
  
  
}
  
  
  
}
  
  
]
  
},
  
"ts": 0,
  
"rid": "string",
  
"msg": "string",
  
"success": true
}

试验场

服务器
授权
请求头
主体

示例

技术支持 VitePress OpenAPI