搜索附件

GET 
/wiki/search/resources

History

Version	Changes
v6.43.0	Added in: v6.43.0

搜索附件。

Request

Query Parameters

teamID stringrequired

团队ID

requestUserID string

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

limit integer

Possible values: <= 100

Default value: 50

本次请求要返回的数量，默认值为50，超过100会被截断为100

cursor string

本次请求的起始位置

keyword stringrequired

Possible values: <= 100 characters

搜索关键字

Responses

200

成功

application/json

Schema

Schema

data

object

hasNext boolean

是否有下一页

nextCursor string

下一页游标

total integer

搜索匹配总数

resources

object[]

Array [

fields

object

createdTime integer

创建时间

mime string

媒体类型

name string

附件名称

ownerID string

上传者 ID

pageTitle string

页面标题

pageID string

页面 ID

referenceID string

引用 ID

referenceType string

引用类型

spaceName string

页面组名称

spaceID string

页面组 ID

id string

附件 ID

highlightFields

object

name string[]

匹配到的名称

content string[]

匹配到的内容

]

result string

本次请求结果,SUCCESS|FAIL

errorCode string

本次请求错误码

errorMsg string

本次请求错误信息

errorData object

本次请求错误元数据

Example (from schema)

{
  "data": {
    "hasNext": true,
    "nextCursor": "string",
    "total": 0,
    "resources": [
      {
        "fields": {
          "createdTime": 0,
          "mime": "string",
          "name": "string",
          "ownerID": "string",
          "pageTitle": "string",
          "pageID": "string",
          "referenceID": "string",
          "referenceType": "string",
          "spaceName": "string",
          "spaceID": "string",
          "id": "string"
        },
        "highlightFields": {
          "name": [
            "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...