主页 > API > 获取项目详情


获取项目详情

/v1/projects/:pid
  • URL

    https://api.worktile.com/v1/projects/:pid

  • HTTP请求方式

    GET

  • 支持格式

    JSON

    Header参数

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

    示例

    curl -l https://api.worktile.com/v1/projects/22222?access_token=xxx
    
  • HTTP请求参数

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

    示例

    HTTP/1.1 200 ok

    { "pid":"eda54f766b7f457ea7cdb5a93c6d892e", "name":"Worktile 开发", "desc":"", "archived":0, "pic":"icon-github", "bg":"#5d8d0b", "visibility":2, "team_id":"b809bef616fd4faa994a84ac61f922a1", "labels":[ { "name":"blue", "desc":"需求" }, { "name":"green", "desc":"不重要" }, { "name":"orange", "desc":"一般" }, { "name":"purple", "desc":"哈哈" }, { "name":"red", "desc":"非常紧急" }, { "name":"yellow", "desc":"紧急" } ], "created_by":{ "uid":"679efdf3960d45a0b8679693098135ff", "name":"gonglinjie", "display_name":"龚林杰", "avatar":"default_avatar.png", "desc":"", "status":3, "online":0 } }


    返回值字段 类型 说明
    pid string 项目pid
    name string 项目名称
    desc string 项目描述
    archived number 是否存档,0:未存档,1:已存档
    pic string 项目图标
    bg string 项目背景颜色
    visibility number 项目类型,1:私有项目,2:团队项目,3:公开项目
    team_id string 团队team_id
    labels Array 标签集合 详情 收起
        name string 标签名称
        desc string 标签描述
    created_by 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/projects/:pid" }


    错误码(error_code) 错误信息(error_message) http状态码(statusCode)
    100005 没授权,请授权后再操作 401
    100006 access_token不正确 400
    400002 project_id不能为空 400
    400003 获取项目失败 500
    400004 项目不存在 404