主页 > API > 更新文档


更新文档

/v1/pages/:page_id
  • URL

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

  • HTTP请求方式

    PUT

  • 支持格式

    JSON

    Header参数

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

    示例

    curl -X PUT -d 'name=openApi文档&content=文档接口&parent_id=xxx' '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中
    name true string 文档名称
    content false string 文档内容
    parent_id false string 父文档id
  • 返回数据

    示例

    HTTP/1.1 200 ok

    { "success":"true" }


    返回值字段 类型 说明
    success boolean true: 更新成功
  • 异常结果

    示例

    HTTP/1.1 400 Bad Request

    { "error_code":120002, "error_message":"文档名称为空", "request":"/v1/pages/:page_id" }


    错误码(error_code) 错误信息(error_message) http状态码(statusCode)
    100005 没授权,请授权后再操作 401
    100006 access_token不正确 400
    120002 文档名称为空 400
    120004 文档不存在 404
    120006 文档更新失败 500