主页 > API > 文件/文件夹列表


文件/文件夹列表

/v1/files
  • URL

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

  • HTTP请求方式

    GET

  • 支持格式

    JSON

    Header参数

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

    示例

    curl -l https://api.worktile.com/v1/files?folder_id=folderidxxx&pid=pidxxxaccess_token=xxx
    
  • HTTP请求参数

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

    示例

    HTTP/1.1 200 ok

    [ { "fid":"bd0b0749c0d6457294a3d20389646477", "name":"12341243", "desc":"", "pid":"eda54f766b7f457ea7cdb5a93c6d892e", "path":"", "folder_id":"", "folder_name":"根目录", "type":1, "created_at":"2015-03-23T02:09:08.023Z", "updated_at":"2015-03-23T02:09:08.023Z", "watchers":[ ], "owner":{ "uid":"04f36f0fd25c4521b8bb80d1543eb92a", "name":"wangwei", "display_name":"王维", "avatar":"ea9365fa-0901-45da-bca6-042b09bd9905.png", "desc":"", "status":3, "online":0 } }, { "fid":"9a20b6194f8843dfa54e9670ebdc4859", "name":"Metallic-Logo-PSD-Mock-Up-worktile.jpg", "desc":"", "pid":"eda54f766b7f457ea7cdb5a93c6d892e", "size":"781055", "path":"eda54f766b7f457ea7cdb5a93c6d892e/91282eea-9c35-4738-b8cd-1f8aa2a9e15b.jpg", "folder_id":"", "folder_name":"根目录", "type":0, "created_at":"2015-03-20T06:47:13.400Z", "updated_at":"2015-03-20T06:47:13.400Z", "watchers":[ { "uid":"d4745f9a9a6641c0a471182b6cdf909a", "name":"xuhaifeng", "display_name":"徐海峰", "avatar":"5a69f6124d484f589996b1956126cf52.jpg", "desc":"我真的很靠谱", "status":3, "online":0 } ], "owner":{ "uid":"ab050727f8de490d85dbc201a4662bd0", "name":"liuhao", "display_name":"liuhao", "avatar":"default_avatar.png", "desc":"", "status":3, "online":0 } } ]


    返回值字段 类型 说明
    fid string 文件的fid
    name string 文件名称
    desc string 文件描述
    pid string 项目pid
    size string 文件大小
    path string 文件路径
    folder_id string 文件父目录的id
    folder_name string 文件父目录的名称
    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:离开
  • 异常结果

    示例

    HTTP/1.1 401 Unauthorized

    { "error_code":100005, "error_message":"未授权,请授权后再操作", "request":"/v1/files" }


    错误码(error_code) 错误信息(error_message) http状态码(statusCode)
    100005 未授权,请授权后再操作 401
    100006 access_token不正确 400
    800001 获取文件或文件夹列表失败 500