搜索页面

GET 
/wiki/search/pages

History

Version	Changes
v6.2.16	Added in: v6.2.16

搜索页面。

Request

Query Parameters

teamID stringrequired

团队ID

requestUserID string

用户 ID，此参数仅在作为 Oauth 机器人调用时才能传递。它用于以指定用户的身份执行操作

limit integer

Possible values: <= 500

Default value: 500

本次请求要返回的数量，默认值为500，超过500或小于等于0会被设置为500

cursor string

本次请求的起始位置

keyword stringrequired

Possible values: <= 100 characters

搜索关键字

spaceIDs string

页面组 ID 列表，多个用逗号分隔，空字符串为搜索所有页面组

includeArchived boolean

默认值 false，true: 包含已归档页面，false: 不包含已归档页面

Responses

200

成功

application/json

Schema

Schema

data

object

hasNext boolean

是否有下一页

nextCursor string

下一页游标

total integer

搜索匹配总数

pages

object[]

Array [

fields

object

id string

页面 ID

title string

页面标题

highlightFields

object

title string[]

匹配到的标题

content string[]

匹配到的内容

]

result string

本次请求结果,SUCCESS|FAIL

errorCode string

本次请求错误码

errorMsg string

本次请求错误信息

errorData object

本次请求错误元数据

Example (from schema)

{
  "data": {
    "hasNext": true,
    "nextCursor": "string",
    "total": 0,
    "pages": [
      {
        "fields": {
          "id": "string",
          "title": "string"
        },
        "highlightFields": {
          "title": [
            "string"
          ],
          "content": [
            "string"
          ]
        }
      }
    ]
  },
  "result": "string",
  "errorCode": "string",
  "errorMsg": "string",
  "errorData": {}
}

401

如果身份验证凭据不正确或丢失，则返回

application/json

Schema

Schema

result string

本次请求结果,SUCCESS|FAIL

errorCode string

本次请求错误码

errorMsg string

本次请求错误信息

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "Unauthorized",
  "errorMsg": "Access token is invalid"
}

403

如果scope检验不通过，则返回

application/json

Schema

Schema

result string

本次请求结果,SUCCESS|FAIL

errorCode string

本次请求错误码

errorMsg string

本次请求错误信息

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "Forbidden",
  "errorMsg": "Scope is invalid"
}

404

如果未找到资源对象，则返回

application/json

Schema

Schema

result string

本次请求结果,SUCCESS|FAIL

errorCode string

本次请求错误码

errorMsg string

本次请求错误信息

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "NotFound",
  "errorMsg": "Not Found"
}

500

内部服务器错误

application/json

Schema

Schema

result string

本次请求结果,SUCCESS|FAIL

errorCode string

本次请求错误码

errorMsg string

本次请求错误信息

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "Internal Server Error",
  "errorMsg": "Internal Server Error"
}

Loading...