主页 > API > 修改文件名和描述


修改文件名和描述

/v1/files/:fid
  • URL

    https://api.worktile.com/v1/files/:fid

  • HTTP请求方式

    PUT

  • 支持格式

    JSON

    Header参数

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

    示例

    curl -X PUT -d 'name=文件名&desc=文件描述' https://api.worktile.com/v1/files/fidxxxx?pid=pidxxx&access_token=xxx
    
  • HTTP请求参数

    参数 必选 类型 说明
    fid true string 文件fid
    pid true string 项目pid
    access_token true string OAuth授权后获得,请求时可放在header中
    name true string 文件名称
    desc false string 文件描述
  • 返回数据

    示例

    HTTP/1.1 200 ok

    { "success":"true" }


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

    示例

    HTTP/1.1 404 Not Found

    { "error_code":800004, "error_message":"文件不存在", "request":"/v1/files/fidxxx" }


    错误码(error_code) 错误信息(error_message) http状态码(statusCode)
    100005 未授权,请授权后再操作 401
    100006 access_token不正确 400
    800004 文件不存在 404
    800005 文件名称不能为空 400
    800006 更新文件信息失败 500