项目接口¶
-
class
teambition.api.projects.
Projects
(client=None)[源代码]¶ -
add_members
(id, email)[源代码]¶ 添加项目成员
详情请参考 http://docs.teambition.com/wiki/projects#projects-add-member
参数: - id – 项目 ID
- email – 邮箱或邮箱列表
返回: 返回的 JSON 数据包
-
copy
(id, name, organization_id=None, is_public=False)[源代码]¶ 复制项目
详情请参考 http://docs.teambition.com/wiki/projects#projects-copy
参数: - id – 路径参数
- name – 新项目名称
- organization_id – 可选,所属组织 ID,若为空则属于个人
- is_public – 可选,是否公开,默认为 False
返回: 返回的 JSON 数据包
-
create
(name, description=None, logo=None, categroy=None, divider_index=None, organization_id=None)[源代码]¶ 新建项目
详情请参考 http://docs.teambition.com/wiki/projects#projects-create
参数: - name – 项目名称
- description – 可选,项目描述
- logo – 可选,项目 logo
- category – 可选,项目类别
- divider_index – 可选,dividers 中得 index,仅对拥有者有效
- organization_id – 可选,组织 ID,创建组织项目时需要提供此参数
返回: 新建的项目信息
-
create_members
(id, email)¶ 添加项目成员
详情请参考 http://docs.teambition.com/wiki/projects#projects-add-member
参数: - id – 项目 ID
- email – 邮箱或邮箱列表
返回: 返回的 JSON 数据包
-
create_webhook
(id, callback_url, active=True, events=None)[源代码]¶ 新建项目 webhook
参数: - id – 项目 ID
- callback_url – 回调地址,Teambition通过HEAD请求进行测试, 有事件被触发将发送POST请求
- active – 可选,是否激活,默认为 True
- events – 可选,事件列表,默认为空
返回: 返回的 JSON 数据包
-
delete
(id)[源代码]¶ 删除项目
详情请参考 http://docs.teambition.com/wiki/projects#projects-delete
参数: id – 路径参数 返回: 返回的 JSON 数据包
-
get
(id=None, team_id=None, is_archived=False)[源代码]¶ 获取项目信息
详情请参考 http://docs.teambition.com/wiki/projects#projects-get
参数: - id – 可选,不提供则返回用户所在的项目
- team_id – 可选,团队 ID,提供可获取团队所在项目
- is_archived – 返回归档的项目,默认为 False
返回: 返回的 JSON 数据包
-
get_activities
(id, start_date=None, end_date=None, limit=30)[源代码]¶ 获取主页动态
详情请参考 http://docs.teambition.com/wiki/projects#projects-home-activities
参数: - id – 项目 ID
- start_date – 可选,开始时间,默认为当天的开始
- end_date – 可选,结束时间,默认为当天的 23 时 59 分 59 秒
- limit – 可选,数量限制,默认为 30
返回: 返回的 JSON 数据包
-
get_events
(id=None, start_date=None, end_date=None)[源代码]¶ 获取项目日程
详情请参考 http://docs.teambition.com/wiki/projects#projects-get-events
参数: - id – 可选,项目 ID
- start_date – 可选,起始日期
- end_date – 可选,截止日期
返回: 返回的 JSON 数据包
-
get_members
(id, user_id=None)[源代码]¶ 获取项目成员
详情请参考 http://docs.teambition.com/wiki/projects#projects-get-members
参数: - id – 项目 ID
- user_id – 可选,成员 ID
返回: 返回的 JSON 数据包
-
get_recommend_members
(id)[源代码]¶ 获取项目推荐成员列表
详情请参考 http://docs.teambition.com/wiki/projects#projects-recommend-members
参数: id – 项目 ID 返回: 返回的 JSON 数据包
-
get_reviews
(id, start_date=None, end_date=None)[源代码]¶ 获取项目历史动态
详情请参考 http://docs.teambition.com/wiki/projects#projects-reviews
参数: - id – 项目 ID
- start_date – 可选,开始时间,默认为当天的开始
- end_date – 可选,结束时间,默认为当天的 23 时 59 分 59 秒
返回: 返回的 JSON 数据包
-
get_statistic
(id, today=True)[源代码]¶ 获取项目统计数据
详情请参参考 http://docs.teambition.com/wiki/projects#projects-statistic
参数: - id – 项目 ID
- today – 可选,默认为今天,以该日期为准,退后五天内每天的任务完成数
返回: 返回的 JSON 数据包
获取项目标签列表
参数: id – 项目 ID 返回: 返回的 JSON 数据包
-
get_tasklists
(id)[源代码]¶ 获取项目任务分组列表
详情请参考 http://docs.teambition.com/wiki/tasklists#tasklists-get
参数: id – 项目 ID 返回: 返回的 JSON 数据包
-
get_tasks
(id=None, executor_id=None, fields=None, subtask_fields=None, with_tasklist=False, with_subtasks=False, with_tags=False, with_executor=False, is_done=False, all=False, page=1, limit=30, **kwargs)[源代码]¶ 获取项目任务
详情请参考 http://docs.teambition.com/wiki/projects#projects-get-tasks
参数: - id – 可选,项目 ID
- executor_id – 可选,执行者 ID
- field – 可选,属性列表, 如: _id,_projectId,isDone,content
- subtask_fields – 可选,子任务属性列表,有: _id, _taskId, _executorId, content, order
- with_tasklist – 可选,是否包含任务分组信息,默认为 False
- with_subtasks – 可选,是否包含子任务信息,默认为 False
- with_tags – 可选,是否包含标签信息,默认为 False
- with_executor – 可选,是否包含执行者信息,默认为 False
- is_done – 可选,是否完成,默认为 False
- all – 可选,是否包含所有类型,包括完成与未完成,默认为 False
- page – 可选,页码,默认为 1
- limit – 可选,每页数量,默认为 30 ,最大为 1000
返回: 返回的 JSON 数据包
-
quit
(id)[源代码]¶ 退出项目
详情请参考 http://docs.teambition.com/wiki/projects#projects-quit
参数: id – 项目 ID 返回: 返回的 JSON 数据包
-
remove_member
(id, user_id)[源代码]¶ 删除项目成员
详情请参考 http://docs.teambition.com/wiki/projects#projects-remove-member
参数: - id – 项目 ID
- user_id – 成员 ID
返回: 返回的 JSON 数据包
-
resend_invitation
(id, user_id)[源代码]¶ 重发邀请邮件
详情请参考 http://docs.teambition.com/wiki/projects#projects-resend-invitation
参数: - id – 项目 ID
- user_id – 成员 ID
返回: 返回的 JSON 数据包
-
reset_invitation
(id)[源代码]¶ 重置项目邀请链接
详情请参考 http://docs.teambition.com/wiki/projects#projects-reset-invitelink
参数: id – 项目 ID 返回: 返回的 JSON 数据包
-
star
(id)[源代码]¶ 项目加星
详情请参考 http://docs.teambition.com/wiki/projects#projects-star
参数: id – 路径参数
-
transfer
(id, organization_id=None)[源代码]¶ 移交项目
详情请参考 http://docs.teambition.com/wiki/projects#projects-transfer
参数: - id – 项目 ID
- organization_id – 目的组织 ID
-
unstar
(id)[源代码]¶ 取消项目加星
详情请参考 http://docs.teambition.com/wiki/projects#projects-star
参数: id – 路径参数
-
update
(id, name=None, description=None, logo=None, category=None, is_archived=None, is_public=None)[源代码]¶ 更新项目
详情请参考 http://docs.teambition.com/wiki/projects#projects-update
参数: - id – 路径参数
- name – 项目名称
- description – 可选,项目描述
- logo – 可选,项目 logo
- category – 可选,项目类别
- is_archived – 可选,是否归档
- is_public – 是否公开,需要拥有者权限
返回: 返回的 JSON 数据包
-
update_member_role
(id, user_id, role_type)[源代码]¶ 更新项目成员角色
详情请参考 http://docs.teambition.com/wiki/projects#projects-update-member
参数: - id – 项目 ID
- user_id – 成员 ID
- role_type – 角色类型, 可选值 member, admin, owner
返回: 返回的 JSON 数据包
更新项目应用导航
详情请参考 http://docs.teambition.com/wiki/projects#projects-update-apps
参数: - id – 项目 ID
- navigation – 字典,新的应用顺序
返回: 返回的 JSON 数据包
-
update_tasklists
(id, tasklist_ids)[源代码]¶ 自定义项目内任务分组排序
详情请参考 http://docs.teambition.com/wiki/projects#projects-update-tasklistIds
参数: - id – 项目 ID
- tasklist_ids – 所有未归档的任务分组 ID 列表
返回: 返回的 JSON 数据包
-
update_webhook
(id, hook_id, callback_url=None, active=True, events=None, add_events=None, remove_events=None)[源代码]¶ 更新项目 webhook
参数: - id – 项目 ID
- hook_id – webhook ID
- callback_url – 可选,回调地址,Teambition通过HEAD请求进行测试, 有事件被触发将发送POST请求
- active – 可选,是否激活,默认为 True
- events – 可选,事件列表,默认为空
- add_events – 可选,追加新的事件进去
- remove_events – 可选,从原有的事件列表中移除
返回: 返回的 JSON 数据包
-