资源工坊

搜索团队文档库 ​

标签：文档库

请求说明 ​

字段值
请求地址
https://openapi.wps.cn/v7/doclib/search
HTTP 方法
GET
接口描述
搜索文档库
签名方式
KSO-1
限频策略
无
权限要求
查询和管理文档库(应用授权) kso.doclib.readwrite
查询文档库(应用授权) kso.doclib.read
查询和管理文档库(用户授权) kso.doclib.readwrite
查询文档库(用户授权) kso.doclib.read

请求头 (Headers) ​

属性名类型是否必填描述可选值
X-Kso-Id-Type
string否类型
* internal - 内部
* external - 外部
internal, external

查询参数 (Query) ​

属性名类型是否必填描述可选值
page_size
integer是分页大小-
page_token
string否分页token-
company_id
string是企业ID-
keyword
string是搜索关键字-
group_type
object否类型-
group_source
array否来源-
with_total
boolean否是否返回搜索到的总条数-

响应体(Response) ​

HTTP状态码: 200
响应体格式: application/json

没有可用的数据

响应体示例 ​

json
{
  "data": {
    "items": [
      {
        "highlights": {
          "example_key": [
            "string"
          ]
        },
        "drive": {
          "allotee_id": "string",
          "allotee_type": "user",
          "company_id": "string",
          "created_by": {
            "avatar": "string",
            "company_id": "string",
            "id": "string",
            "name": "string",
            "type": "user"
          },
          "ctime": 0,
          "description": "string",
          "ext_attrs": [
            {
              "name": "string",
              "value": "string"
            }
          ],
          "id": "string",
          "mtime": 0,
          "name": "string",
          "quota": {
            "deleted": 0,
            "remaining": 0,
            "total": 0,
            "used": 0
          },
          "source": "string",
          "status": "inuse"
        },
        "group": {
          "avatar": "string",
          "company_id": "string",
          "creator_id": "string",
          "ctime": 0,
          "dept_id": "string",
          "description": "string",
          "id": "string",
          "mail": "string",
          "member_total": 0,
          "mtime": 0,
          "name": "string",
          "owner_id": "string",
          "source": "string",
          "status": "enable",
          "type": "normal"
        },
        "pinned": true,
        "user_role": "readonly"
      }
    ],
    "next_page_token": "string"
  },
  "code": 0,
  "msg": "string"
}