主页 > API > 上传文件


上传文件

/v1/file
  • URL

    https://api.worktile.com/v1/file?pid=pidxxx&access_token=xxx

  • HTTP请求方式

    POST

  • 支持格式

    form 表单

    Header参数

    {
       "Content-Type":"multipart/form-data"
    }
    

    示例

    https://api.worktile.com/v1/file?pid=pidxxx&access_token=xxx
    
  • HTTP请求参数

    参数 必选 类型 说明
    pid true string 项目pid
    access_token true string OAuth授权后获得,请求时可放在header中
    type false string 上传文件关联的类型:project,task,post,event,默认值:project
    folder_id false string 文件夹id,如果type的值为project,需要传该属性,默认值为空
    tid true string 如果type为task,必须传tid
    post_id true string 如果type为post,必须传post_id
    event_id true string 如果type为event,必须传event_id
    file true file 上传的文件/文件流
  • 返回数据

    示例

    HTTP/1.1 200 ok

    { "fid":"ae09d6f2994e403587b7bc1d7d06d9eb", "name":"6609c93d70cf3bc7add6743ed300baa1cc112a09.jpg", "desc":"", "pid":"eda54f766b7f457ea7cdb5a93c6d892e", "size":"34905", "path":"eda54f766b7f457ea7cdb5a93c6d892e/94d776b3-e989-47d5-9ac6-664e93f1870a.jpg", "folder_id":"", "type":0, "created_at":"2015-03-03T05:26:56.992Z", "updated_at":"2015-03-03T05:26:56.992Z", "watchers":[ { "uid":"d4745f9a9a6641c0a471182b6cdf909a", "name":"haifeng", "display_name":"徐海峰", "avatar":"5a69f6124d484f589996b1956126cf52.jpg", "desc":"我真的很靠谱1", "status":3, "online":0 }, { "uid":"679efdf3960d45a0b8679693098135ff", "name":"gongmoumou", "display_name":"龚某某", "avatar":"default_avatar.png", "desc":"", "status":3, "online":0 } ], "owner":{ "uid":"d4745f9a9a6641c0a471182b6cdf909a", "name":"haifeng", "display_name":"徐海峰", "avatar":"5a69f6124d484f589996b1956126cf52.jpg", "desc":"我真的很靠谱1", "status":3, "online":0 } }


    返回值字段 类型 说明
    fid string 文件的fid
    name string 文件名称
    desc string 文件描述
    pid string 项目pid
    size string 文件大小
    path string 文件路径
    folder_id string 文件父目录的id
    type string 文件类型:0:文件,1:文件夹
    created_at string 上传时间
    updated_at string 更新时间
    watchers array 关注文件的成员集合 详情 收起
        uid string 关注文件的成员uid
        name string 关注文件的成员用户名
        display_name string 关注文件的成员昵称
        avatar string 关注文件的成员头像
        desc string 关注文件的成员说明
        status number 关注文件的成员状态:1:正常,2:邀请,3:需要邮件确认
        online number 成员的在线状态,0:离线,1:在线,2:忙碌,3:离开
    owner object 上传文件的用户 详情 收起
        uid string 用户uid
        name string 用户名
        display_name string 用户昵称
        avatar string 用户头像
        desc string 用户的说明
        status number 用户状态:1:正常,2:邀请,3:需要邮件确认
        online number 用户在线状态,0:离线,1:在线,2:忙碌,3:离开

    示例

    //请求

    <form method='post' enctype='multipart/form-data' action='https://api.worktile.com/v1/file?pid=xxxx&access_token=xC5rHa5hnE'> <input type='file' name='file'/> <!--<input name='folder_id' value='8210102616f740f095c10c353ea796b0'/>--> <input name='tid' value='79fba15624964a839f6221e7e93717df'/> <input name='type' value='task'/> <input type='submit' value='ok'/> </form>

  • 异常结果

    示例

    HTTP/1.1 400 Bad Request

    { "error_code":800009, "error_message":"参数不正确", "request":"/v1/file" }


    错误码(error_code) 错误信息(error_message) http状态码(statusCode)
    100005 未授权,请授权后再操作 401
    100006 access_token不正确 400
    800009 参数不正确 400
    800010 上传文件失败 500