获取页面详情

GET 
https://your-domain/openapi/v2/wiki/pages/:pageID

History

Version	Changes
v6.2.16	Added in: v6.2.16
v6.12.0	详细区分响应中 refType，增加 locked 属性

获取页面详情。

Request

Path Parameters

pageID stringrequired

页面 ID

Query Parameters

teamID stringrequired

团队ID

requestUserID string

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

Responses

200

成功

application/json

Schema

Schema

data

object

id string

页面 ID

title string

页面名称

spaceID string

页面组 ID

createdTime integer

创建时间

updatedTime integer

更新时间

parentID string

父页面 ID

refType string

引用类型

refID string

引用 ID

subRefType string

子引用类型

isArchived boolean

是否归档

encryptStatus string

加密状态，none: 未加密，encrypted: 已加密，readonly: 只读

canEdit boolean

是否可编辑

locked boolean

是否锁定

creatorID string

创建者 ID

modifierID string

修改者 ID

content string

页面内容

isFavorite boolean

是否收藏

token string

页面 token， collaboration 页面才会返回此字段，用于连接编辑服务

result string

The result of this request.

errorCode string

The error code of this request.

errorMsg string

Error message for this request.

errorData object

Error meta data for this request.

Example (from schema)

{
  "data": {
    "id": "string",
    "title": "string",
    "spaceID": "string",
    "createdTime": 0,
    "updatedTime": 0,
    "parentID": "string",
    "refType": "string",
    "refID": "string",
    "subRefType": "string",
    "isArchived": true,
    "encryptStatus": "string",
    "canEdit": true,
    "locked": true,
    "creatorID": "string",
    "modifierID": "string",
    "content": "string",
    "isFavorite": true,
    "token": "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"
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L 'https://your-domain/openapi/v2/wiki/pages/:pageID' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Base URL

https://your-domain/openapi/v2

Auth

Bearer Token

Parameters

pageID — pathrequired

teamID — queryrequired

requestUserID — query

ResponseClear

Click the Send API Request button above and see the response here!