跳到主要内容
危险

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

模型

项目迭代阶段​

project_sprint_status

参数名类型说明
uuidstring阶段 id
namestring阶段名
categorystring阶段分类
build_intbool是否内置阶

迭代阶段​

sprint_status

参数名类型说明
status_uuidstring阶段 id
namestring阶段名
categorystring阶段分类
plan_start_timeint64计划开始时间(单位秒)
plan_end_timeint64计划完成时间(单位秒)
actual_start_timeint64实际开始时间(单位秒)
actual_end_timeint64实际完成时间(单位秒)
is_current_statusbool是否当前阶段
desc_plainstring阶段描述, 纯文本(富文本转的纯文本，不限字数)
desc_richstring阶段描述，富文

阶段分类​

category

key说明
to_do未开始
in_progress进行中
done已完成

HTTP status code 说明​

状态码说明
200成功
403没权限
500服务器内部错误
801参数不合法

API 说明

1.添加项目下迭代阶段​

URL​

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

HTTP Method​

POST

是否需要登录​

是

调用权限​

manage_sprints

请求参数​

参数名类型是否必填说明
statusobjectT迭代阶段

status 对象

参数名类型是否必填说明
namestringF阶段名

返回参数​

参数名类型是否必填说明
statusobjectT迭代阶段
server_update_stampintT数据更新时间（微妙）

status 对象

参数名类型是否必填说明
uuidstringT阶段 id
namestringT阶段名
categorystringT阶段分类
build_inboolT是否内置阶

请求体参考​

{
  "status": {
    "name": "the stage of this test sprint"
  }
}

返回体参考​

{
  "status": {
    "uuid": "Nj8WkR3T",
    "name": "the stage of this test sprint",
    "category": "in_progress",
    "build_in": false
  },
  "server_update_stamp": 1594365070498608
}

2.修改项目下迭代阶段​

  • 修改阶段名称或者调整阶段顺序
  • 未开始为迭代固定阶段，表示迭代尚未开始，不可编辑和删除。
  • 已完成为迭代固定阶段，表示迭代正式完成，不可编辑和删除。

URL​

https://your-host-name/project/api/project/team/:teamUUID/project/:projectUUID/sprint_status/:statusUUID/update

HTTP Method​

POST

是否需要登录​

是

调用权限​

manage_sprints

请求参数​

参数名类型是否必填说明
statusobjectT阶段

status 对象

参数名类型是否必填说明
namestringF阶段名
next_uuidstringF移动后上一个阶段的 id

返回参数​

参数名类型是否必填说明
statusobjectT迭代阶段
server_update_stampintT数据更新时间（微妙）

status 对象

参数名类型是否必填说明
uuidstringT阶段 id
namestringT阶段名
categorystringT阶段分类
build_inboolT是否内置阶

请求参数参考​

{
  "status": {
    "uuid": "Nj8WkR3T",
    "next_uuid": "N1Kw7tiD" // Adjust Nj8WkR3T order to before N1Kw7tiD
  }
}
{
  "status": {
    "name": "updateStageName", // Modify the name of this sprint stage
    "uuid": "Nj8WkR3T"
  }
}

返回参数参考​

{
  "status": {
    "uuid": "Nj8WkR3T",
    "name": "updateStageName",
    "category": "in_progress",
    "build_in": false
  },
  "server_update_stamp": 1594368272833664
}

3.删除项目下迭代阶段​

  • 删除操作将会一并删除已有的该项阶段内容，此操作不可撤销.

URL​

https://your-host-name/project/api/project/team/:teamUUID/project/:projectUUID/sprint_status/:statusUUID/delete

HTTP Method​

POST

是否需要登录​

是

调用权限​

manage_sprints

请求参数​

无

返回参数​

参数名类型是否必填说明
server_update_stampintT数据更新时间（微妙）

4.获取项目迭代阶段列表​

https://your-host-name/project/api/project/team/:teamUUID/project/:projectUUID/sprint_statuses

HTTP Method​

GET

是否需要登录​

是

调用权限​

BrowseProject

请求参数​

无

返回参数​

参数名类型是否必填说明
statuses[]objectT迭代阶段

statuses 对象

参数名类型是否必填说明
uuidstringT阶段 id
namestringT阶段名
categorystringT阶段分类
build_inboolT是否内置阶

返回体参考​

{
  "statuses": [
    {
      "uuid": "84oYKyg2",
      "name": "to do",
      "category": "to_do",
      "build_in": true
    },
    {
      "uuid": "4Jcq6XbX",
      "name": "in progress",
      "category": "in_progress",
      "build_in": false
    },
    {
      "uuid": "K6y6vDHE",
      "name": "requirement",
      "category": "in_progress",
      "build_in": false
    },
    {
      "uuid": "JiJXQCrB",
      "name": "plan",
      "category": "in_progress",
      "build_in": false
    },
    {
      "uuid": "JkY1AtwT",
      "name": "develop",
      "category": "in_progress",
      "build_in": false
    },
    {
      "uuid": "8kmtuDfj",
      "name": "product testing",
      "category": "in_progress",
      "build_in": false
    },
    {
      "uuid": "N1Kw7tiD",
      "name": "product launch",
      "category": "in_progress",
      "build_in": false
    },
    {
      "uuid": "BAYxXXtB",
      "name": "done",
      "category": "done",
      "build_in": true
    }
  ]
}

5.修改迭代阶段​

https://your-host-name/project/api/project/team/:teamUUID/project/:projectUUID/sprint/:sprintUUID/sprint_statuses/update

HTTP Method​

POST

是否需要登录​

是

调用权限​

manage_sprints

请求参数​

参数名类型是否必填说明
sprint_statuses[]objectT迭代阶段

sprint_statuses 对象

参数名类型是否必填说明
status_uuidstringF阶段 id
namestringF阶段名
categorystringF阶段分类
plan_start_timeintF计划开始时间(单位秒)
plan_end_timeintF计划完成时间(单位秒)
actual_start_timeintF实际开始时间(单位秒)
actual_end_timeintF实际完成时间(单位秒)
is_current_statusboolT是否当前阶段
desc_plainstringF阶段描述, 纯文本(富文本转的纯文本，不限字数)
desc_richstringF阶段描述，富文本

返回参数​

参数名类型是否必填说明
server_update_stampintT数据更新时间（微妙）

请求参数参考​

修改阶段描述

{
  "sprint_statuses": [
    {
      "status_uuid": "K6y6vDHE",
      "name": "requirement review",
      "category": "in_progress",
      "plan_start_time": 1533571200,
      "plan_end_time": 1533657600,
      "actual_start_time": 1533571200,
      "actual_end_time": 1533657600,
      "is_current_status": false,
      "desc_plain": "",
      "desc_rich": "<p>this is the description of requirement.</p>\n"
    }
  ]
}

修改迭代当前阶段，需要将原阶段 is_current_status 参数置为 false

{
  "sprint_statuses": [
    {
      "status_uuid": "K6y6vDHE",
      "name": "requirement review",
      "category": "in_progress",
      "plan_start_time": 1533571200,
      "plan_end_time": 1533657600,
      "actual_start_time": 1533571200,
      "actual_end_time": 1533657600,
      "is_current_status": true,
      "desc_plain": "",
      "desc_rich": "<p>description</p>\n"
    },
    {
      "status_uuid": "XvPjnUC9",
      "name": "to do",
      "category": "to_do",
      "plan_start_time": 1533571200,
      "plan_end_time": null,
      "actual_start_time": 1533571200,
      "actual_end_time": null,
      "is_current_status": false,
      "desc_plain": "",
      "desc_rich": "<p>description</p>\n"
    }
  ]
}
最后于 更新