You need to enable JavaScript to run this app.
导航

公共参数

最近更新时间2021.10.27 13:53:12

首次发布时间2021.07.05 14:57:37

API请求资源获取说明

  • projectId 项目ID,创建项目并进入项目页面后可在页面的URL中获取,例如 /project_detail/10001000 为项目ID
  • namespaceId 空间ID,创建空间并进入空间页面后可在页面的URL中获取,例如 /project_detail/1000/space/20002000 为空间ID
  • taskId 任务ID,创建任务并进入任务页面后可在页面的URL中获取,例如 /project_detail/1000/demand/30003000 为任务ID

POST 和 GET 通用参数

当接口为 POST 类型时,需要在 body 中传入 projectId
当接口为 GET 类型时,需要在 query 中传入 projectId

其他通用 query 参数

参数名是否必填类型描述
Actionrequiredstring接口名,例如:Projects
Versionrequiredstring版本号,取值:2021-05-21

API响应结果说明

  • message: 错误信息

    • 请求成功时,success
    • 请求失败时,依照API不同返回不同的错误信息
  • code: 错误码

    • 请求失败时,依照API不同返回不同的错误信息
  • data: API请求成功

    • 说明:在某操作类的API中可能不存在,具体可以参考详细的接口文档
  • pagination: 列表等接口存在翻页数据情况的字段

    • offset 翻页偏移量,默认 0
    • limit 翻页最大数量,默认 25
  • total: 列表等接口总数字段

示例:

// 列表类型
{
    "data": [],
    "total": 1000,
    "pagination": {
    	"offset": 0,
        "limit": 10
    }
}
// 错误类型
{
    "message": "no permission",
    "code": 1000,
}
// 成功操作
{
    "message": "success"
}
// 普通数据类
{
    "data": {
    ...
    }
}

推荐通过服务端SDK来快速调用接口,源码请参考 GitHub

  • SDK封装了TOP签名,避免过于繁琐的自行计算;