主页 > API > 文档详情


文档详情

/v1/pages/:page_id
  • URL

    https://api.worktile.com/v1/pages/:page_id

  • HTTP请求方式

    GET

  • 支持格式

    JSON

    Header参数

    {
       "Content-Type":"application/json",
       "access_token":"xxx"
    }
    

    示例

    curl -l 'https://api.worktile.com/v1/pages/page_idxxx?pid=xxx&access_token=xxx' 
    
  • HTTP请求参数

    参数 必选 类型 说明
    page_id true string 文档id
    pid true string 项目pid
    access_token true string OAuth授权后获得,请求时可放在header中
  • 返回数据

    示例

    HTTP/1.1 200 ok

    { "page_id":"45f88ac3cdbb43bb873f1e2ccf3359f6", "parent_id":"", "pid":"eda54f766b7f457ea7cdb5a93c6d892e", "name":"openApi文档", "summary":"文档接口", "content":"文档接口", "updated_at":"2015-03-27T06:32:11.664Z", "created_at":"2015-03-27T06:32:11.664Z", "owner":{ "uid":"679efdf3960d45a0b8679693098135ff", "name":"gongmoumou", "display_name":"龚某某", "avatar":"default_avatar.png", "desc":"", "status":3, "online":0 }, "watchers":[ { "uid":"679efdf3960d45a0b8679693098135ff", "name":"gongmoumou", "display_name":"龚某某", "avatar":"default_avatar.png", "desc":"", "status":3, "online":0 } ] }


    返回值字段 类型 说明
    page_id string 文档id
    parent_id string 父文档id
    pid string 项目pid
    name string 文档名称
    summary string 文档内容
    content string 文档内容(markdown)
    created_at string 创建时间
    updated_at string 更新时间
    owner object 创建者(用户) 详情 收起
        uid string 用户uid
        name string 用户名
        display_name string 用户昵称
        desc string 用户描述
        avatar string 用户头像
        status number 用户状态:1:正常,2:邀请,3:需要邮件确认
        online number 用户在线状态,0:离线,1:在线,2:忙碌,3:离开
    watchers array 关注文档的用户集合 详情 收起
        uid string 用户uid
        name string 用户名
        display_name string 用户昵称
        desc string 用户描述
        avatar string 用户头像
        status number 用户状态:1:正常,2:邀请,3:需要邮件确认
        online number 用户在线状态,0:离线,1:在线,2:忙碌,3:离开
  • 异常结果

    示例

    HTTP/1.1 404 Not Found

    { "error_code":120004, "error_message":"文档不存在", "request":"/v1/pages/:page_id" }


    错误码(error_code) 错误信息(error_message) http状态码(statusCode)
    100005 没授权,请授权后再操作 401
    100006 access_token不正确 400
    120004 文档不存在 404
    120005 获取文档失败 500