WorktileOpenAPI
    WorktileOpenAPI
    • 概述
    • 个人鉴权 OAuth2
      • OAuth2授权接口模拟静默授权
        • 1. 登录（公有云）
        • 1. 登录（私有部署）
        • 2. 获取 transaction_id(公有云)
        • 2. 获取 transaction_id(私有部署)
        • 3. 获取 code
        • 4. 获取 token
        • 5. 刷新 token
      • 用户接口 (SCIM)
        • 获取个人信息
        • 获取企业成员列表
        • 创建企业成员
        • 禁用企业成员
        • 更新企业成员
        • 修改企业成员属性-启用成员
        • 获取企业成员
        • 修改企业成员-启用
      • 部门接口 (SCIM)
        • 获取部门列表
        • 获取部门详情
        • 创建新部门
        • 更新部门信息
        • 更新部门属性-修改上级部门
        • 更新部门属性-修改部门名称
        • 删除部门
      • 数据导出接口
        • 获取企业数据导出任务列表
      • 任务接口(原任务模块)
        • 获取我的任务列表
        • 获取任务详情
        • 获取项目内的列表和任务
        • 创建任务
    • 团队鉴权 Tenant
      • 鉴权(token)
        • 公有云团队鉴权
          • tenant-access-token
        • 私有环境团队鉴权
          • tenant-access-token（私有部署）
      • 组织架构(contact)
        • 获取成员get members by page
        • get users by uid
        • 获取部门
      • 项目(mission)
        • 项目
          • 创建项目create project by template
          • 获取项目 get-projects-by-page
          • 获取指定项目get project by ids
          • 获取项目分组信息 get-project-groups(v9.12.0)
          • 获取项目属性信息 get-project-info(v9.32.0)
          • 修改项目基本属性 update-project-info-basic(v9.32.0)
          • 修改项目扩展属性 update-project-info-extend(v9.32.0)
          • 获取项目工时信息 get-project-workload(v9.12.0)
        • 任务
          • 标签
            • 获取标签模式 get task tag modes
            • 获取标签模式下标签 get tags by tag mode
          • 任务类型
            • 获取项目任务类型列表
            • 获取全部任务类型 get task types
            • 获取项目任务类型详情
          • 数据源(v9.23.0)
            • 获取数据源列表 get task data sources
            • 获取数据源下数据项列表 get data source items
            • 添加数据项 create item by data source
          • 创建任务
          • 获取项目中任务 get-project-tasks-by-page
          • 获取多个任务 get-tasks-by-ids
          • 获取派生任务get derived tasks
          • 获取相关任务 get-relation-tasks
          • 获取工时get workloads by task ids
          • 更改任务派生关系 update-task-derived-relation
          • 更改任务依赖关系（前后置任务） update task dependent relation
          • 取消任务依赖关系 remove task dependent relation
          • 获取项目工时 get project workloads【不再维护，推荐使用 获取工时 接口】
          • 获取工时类别 get-workload-types
          • 登记工时 create-workload
          • 获取工时
          • 获取项目任务V2（v9.0.0）
          • 获取任务流转信息 get task transitions (v9.0.0)
          • 归档任务 task archive (v9.0.0)
          • 激活任务 task activate (v9.0.0)
          • 获取任务详情
        • 组件
          • 看板
            • 获取看板分组 get project kanban groups
            • 获取项目看板任务 get project kanban tasks
            • 移动任务看板分组 move task kanban group
          • 概览
            • 获取所有项目概览扩展属性 getAllProjectOvewviewExProps (9.1.0)
            • 获取项目概览扩展属性 get project overview extends properties (v9.0.0)
            • 修改项目概览扩展属性（v9.1.0）
            • 获取项目概览基本属性（v9.3.3）
            • 修改项目概览基本属性（v9.3.3）
          • 迭代
            • 获取所有迭代(v9.18.0)
          • 获取项目组件 get project addons
      • 文件(file)
        • upload temp file
        • 获取文件信息
        • 获取文件流
      • 目标(goals)
        • 获取周期列表 cycles
        • 获取目标列表 objectives
        • 获取目标详情 objective detail
        • 获取目标进度 objective progress (v8.2.0)
        • 获取目标关联 objective related (v9.0.0)
      • 审批(approval)
        • 获取模板列表
        • 获取审批列表
        • 获取审批详情
      • 成员(user)
        • 获取成员列表
        • 获取成员组列表
        • 新建成员组
        • 删除成员组
        • 修改成员组
    • 钩子接口 WebHook
      • 项目
        • 创建有下拉框属性的任务
        • 更新属性(update_prop) 时间类
        • 更新属性(update_prop) 负责人
        • 更新属性(update_prop) 附件类
        • 更新属性(update_prop) 下拉框
        • 更新属性(update_prop) 自定义单行文本
        • 更新属性(update_prop) 自定义多行文本 
        • 更新状态(update_state)
      • 消息
        • 简单消息
        • 复合消息
        • 自定义机器人
    • 获取TeamID
      GET

    概述

    欢迎使用#

    Worktile OpenAPI用于通过HTTP与Worktile服务端进行远程交互，例如创建、修改、查询、删除Worktile的资源

    接口调用流程#

    image.png

    鉴权#

    两种鉴权模式#

    个人鉴权 OAuth2#

    接口能力数据范围基于授权人账号决定。

    团队鉴权 Tenant#

    接口能力为所有接口、数据范围为团队全员。

    前提条件#

    鉴权都需要 ClientId 和 Client Secret，可以由 Worktile 管理员在 “管理后台” -> ”应用管理“ -> ”我的应用“中新建应用获取

    创建应用的路径位置#

    公有云：https://*.worktile.com/console/apps/my
    私有部署：http://{访问地址}/console/apps/my
    image.png

    鉴权token有效期#

    团队鉴权：7200秒
    个人鉴权：7天

    URL结构#

    接口根路径#

    在不同的环境中根路径有所不同：
    公有云的Open API根路径：https://dev.worktile.com
    私有部署的Open API根路径：http://xxxxxx/worktile-openapi
    上传附件文件根路径：http://xxxxxx/worktile-box

    接口频率限制#

    360次/分钟

    属性获取#

    team id#

    每个企业都拥有唯一的team id，获取此信息可通过访问：https://{访问域名}/api/team/lite 查看

    任务属性标识#

    每个任务属性都有唯一的标识，获取此信息可以通过在 “配置中心”->“任务”->“属性”详情页，可以看到。
    image.png
    修改于 2025-10-20 07:21:46
    下一页
    1. 登录（公有云）
    Built with