主页 > API > 获取话题列表

获取话题列表

/v1/posts

  • URL

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

  • HTTP请求方式

    GET

  • 支持格式

    JSON

    Header参数

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

    示例

    curl -l https://api.worktile.com/v1/posts?pid=xxx&access_token=xxx

  • HTTP请求参数

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

  • 返回数据

    示例

    HTTP/1.1 200 ok
    

    [
   {
      "post_id":"a1e47d3da15c4105810fb79faa6b6b7f",
      "pid":"eda54f766b7f457ea7cdb5a93c6d892e",
      "name":"topic aaa",
      "summary":"heloo",
      "content":"heloo",
      "created_at":"2015-03-20T06:57:35.132Z",
      "updated_at":"2015-03-20T06:57:35.132Z",
      "owner":{
         "uid":"ab050727f8de490d85dbc201a4662bd0",
         "name":"liuhao",
         "display_name":"liuhao",
         "avatar":"default_avatar.png",
         "desc":"",
         "status":3,
         "online":0
      },
      "watchers":[
         {
            "uid":"5c9c96dd61044c4eaab437f17dffa6ca",
            "name":"htz",
            "display_name":"贺天卓",
            "avatar":"default_avatar.png",
            "desc":"tet",
            "status":3,
            "online":0
         }
      ]
   }
]

    返回值字段 类型 说明
    post_id string 话题id
    pid string 项目pid
    name string 话题名称
    summary string 话题内容
    content string 话题内容(markdown)
    created_at string 创建时间
    updated_at string 更新时间
    owner object 创建者(用户) 详情 收起
        uid string 用户uid
        name string 用户名
        display_name string 用户昵称
        desc string 用户描述
        avatar string 用户头像
        status number 用户状态：1：正常，2：邀请，3：需要邮件确认
        online number 用户在线状态，0：离线，1：在线，2：忙碌，3：离开
    watchers array 关注话题的成员集合 详情 收起
        uid string 用户uid
        name string 用户名
        display_name string 用户昵称
        desc string 用户描述
        avatar string 用户头像
        status number 用户状态：1：正常，2：邀请，3：需要邮件确认
        online number 用户在线状态，0：离线，1：在线，2：忙碌，3：离开

  • 异常结果

    示例

    HTTP/1.1 500 Server Error
    

    {
   "error_code":900001,
   "error_message":"获取话题列表失败",
   "request":"/v1/posts"
}

    错误码(error_code) 错误信息(error_message) http状态码(statusCode)
    100005 未授权，请授权后再操作 401
    100006 access_token不正确 400
    900001 获取话题列表失败 500