Skip to main content

Version

danger

ONES API 已废弃。请使用Open API。

MODEL​

version​

参数名值类型取值范围说明
uuidstringlen=8随机 8 位字符组成
titlestringlen=64版本号
descstringlen<=65536版本目标（富文本）
assignstringlen=8版本负责人 uuid
release_timeint64版本发布时间(s)
create_timeint64创建时间 单位秒 readonly
categorystring分类
未开始："todo"
进行中："in_progress"
已完成："done"
sprints[]sprint迭代 uuid 数组
product_uuids[]stringlen=16产品 uuid 列表

sprint​

参数名值类型取值范围说明
sprint_uuidstringlen=8迭代 UUID
project_uuidstringlen=16项目 UUID

状态码说明​

状态码说明
200成功
403没有权限 or 没有开启配置
404已删除的返回 404
409sprint 已被存在，不应该重复添加
500服务端异常
812版本负责人不在 team 中
890迭代不存（未找到或已删除）
891版本不存在（未找到或已删除）

获取版本管理列表​

URL​

https://your-host-name/project/api/project/team/:teamUUID/versions

HTTP Method​

GET

调用权限​

manage_versions

传值方式​

JSON

参数列表​

无

返回参数列表​

参数名值类型取值说明
versions[]version版本列表

返回体参考​

{
  "versions": [
    {
      "uuid": "AyS9QWs8",
      "title": "V1.0.0",
      "desc": "",
      "assign": "FtuS5ApR",
      "release_time": 1541924064,
      "create_time": 1538122469,
      "category": "todo",
      "sprints": [],
      "product_uuids": []
    },
    {
      "uuid": "M5an6x7r",
      "title": "我的版本测试",
      "desc": "",
      "assign": "6ZpgEzkk",
      "release_time": 1580029633,
      "create_time": 1579424856,
      "category": "in_progress",
      "sprints": [
        {
          "sprint_uuid": "Y2NmGbMu",
          "project_uuid": "FtuS5ApROKcAI7U1"
        },
        {
          "sprint_uuid": "TvXzWmcQ",
          "project_uuid": "FtuS5ApROKcAI7U1"
        }
      ],
      "product_uuids": []
    }
  ]
}

新建版本管理​

https://your-host-name/project/api/project/team/:teamUUID/versions/add

HTTP Method​

POST

调用权限​

manage_versions

传值方式​

JSON

参数列表​

参数名值类型是否必须取值范围说明
versionversionT版本信息
 titlestringTlen=64版本名称
 assignstringFlen=8版本负责人
 release_timeint64F发布时间
 descstringF版本目标（富文本）
 categorystringF分类
未开始："todo"
进行中："in_progress"
已完成："done"

返回参数参考​

参数名值类型取值说明
versionversion版本列表

请求参数参考​

{
  "version": {
    "release_time": 1593316656,
    "title": "version_create_test",
    "assign": "6ZpgEzkk"
  }
}

返回体参考​

{
  "version": {
    "uuid": "AX3jDED4",
    "title": "version_create_test",
    "desc": "",
    "assign": "6ZpgEzkk",
    "release_time": 1593316656,
    "create_time": 1590983862,
    "category": "todo",
    "sprints": [],
    "product_uuids": []
  }
}

编辑版本管理​

注意编辑版本，要传入全量的更新后的参数，否则相关字段会使用其初始化参数

URL​

https://your-host-name/project/api/project/team/:teamUUID/version/:versionUUID/update

HTTP Method​

POST

调用权限​

manage_versions

传值方式​

JSON

参数列表​

参数名值类型是否必须取值范围说明
versionversionT版本信息
 titlestringTlen=64版本名称
 assignstringFlen=8版本负责人
 release_timeint64F发布时间
 descstringF版本目标（富文本）
 categorystringF分类
未开始："todo"
进行中："in_progress"
已完成："done"

返回参数参考​

参数名值类型取值说明
versionversion版本列表

请求体参考​

{
  "version": {
    "release_time": 1593316656,
    "title": "update_version_name_test",
    "assign": "6ZpgEzkk",
    "uuid": "AX3jDED4"
  }
}

返回体参考​

{
  "version": {
    "uuid": "AX3jDED4",
    "title": "update_version_name_test",
    "desc": "",
    "assign": "6ZpgEzkk",
    "release_time": 1593316656,
    "create_time": 1590983862,
    "category": "todo",
    "sprints": [],
    "product_uuids": ["6ZpgEzkk79SQCVLJ"]
  }
}

删除版本管理​

URL​

https://your-host-name/project/api/project/team/:teamUUID/version/:versionUUID/delete

HTTP Method​

POST

调用权限​

manage_versions

传值方式​

JSON

参数列表​

无

返回参数列表​

无

返回体参考​

{
  "code": 200,
  "errcode": "OK",
  "type": "OK"
}

关联迭代​

URL​

https://your-host-name/project/api/project/team/:teamUUID/version/:versionUUID/sprints/add

HTTP Method​

POST

调用权限​

manage_versions

传值方式​

JSON

参数列表​

参数名值类型是否必须取值范围说明
sprint_uuidstringTlen=8迭代任务的 uuid

返回参数参考​

参数名值类型取值说明
versionversion版本列表

请求体参考​

{
  "sprint_uuid": "5J6xysRB"
}

返回体参考​

{
  "version": {
    "uuid": "M5an6x7r",
    "title": "我的版本测试",
    "desc": "",
    "assign": "6ZpgEzkk",
    "release_time": 1580029633,
    "create_time": 1579424856,
    "category": "in_progress",
    "sprints": [
      {
        "sprint_uuid": "5J6xysRB",
        "project_uuid": "FtuS5ApRTSAkfwI7"
      }
    ],
    "product_uuids": []
  }
}

移出关联的迭代​

URL​

https://your-host-name/project/api/project/team/:teamUUID/version/:versionUUID/sprint/:sprintUUID/delete

HTTP Method​

POST

调用权限​

manage_versions

传值方式​

JSON

参数列表​

无

返回参数参考​

参数名值类型取值说明
versionversion版本列表

返回体参考​

{
  "version": {
    "uuid": "GKy9yuUj",
    "title": "version_name",
    "desc": "",
    "assign": "6ZpgEzkk",
    "release_time": 1591150748,
    "create_time": 1590977961,
    "category": "todo",
    "sprints": [
      {
        "sprint_uuid": "Y2NmGbMu",
        "project_uuid": "FtuS5ApROKcAI7U1"
      }
    ],
    "product_uuids": ["6ZpgEzkkUVfH1vUy"]
  }
}

关联产品​

URL​

https://your-host-name/project/api/project/team/:teamUUID/version/:versionUUID/products/add

HTTP Method​

POST

调用权限​

manage_versions

传值方式​

JSON

参数列表​

参数名值类型是否必须取值范围说明
product_uuids[]stringTlen=16产品 uuid 列表

返回参数参考​

参数名值类型取值说明
versionversion版本列表

请求体参考​

{
  "product_uuids": ["6ZpgEzkk79SQCVLJ"]
}

返回体参考​

{
  "version": {
    "uuid": "AX3jDED4",
    "title": "version_create_test",
    "desc": "",
    "assign": "6ZpgEzkk",
    "release_time": 1593316656,
    "create_time": 1590983862,
    "category": "todo",
    "sprints": [],
    "product_uuids": ["6ZpgEzkk79SQCVLJ"]
  }
}

移出关联的产品​

URL​

https://your-host-name/project/api/project/team/:teamUUID/version/:versionUUID/product/:productUUID/delete

HTTP Method​

POST

调用权限​

manage_versions

传值方式​

JSON

参数列表​

无

返回参数参考​

参数名值类型取值说明
versionversion版本列表

返回体参考​

{
  "version": {
    "uuid": "GKy9yuUj",
    "title": "version_name",
    "desc": "",
    "assign": "6ZpgEzkk",
    "release_time": 1591150748,
    "create_time": 1590977961,
    "category": "todo",
    "sprints": [
      {
        "sprint_uuid": "Y2NmGbMu",
        "project_uuid": "FtuS5ApROKcAI7U1"
      }
    ],
    "product_uuids": []
  }
}
Last updated on