Skip to main content

Sprint

danger

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

模型说明​

迭代详情​

sprint

参数名值类型允许修改取值范围说明
uuidstringFlen=8uuid
project_uuidstringFlen=16所属项目 uuid
titlestringTlen<=32标题
assignstringTlen=8负责人 uuid
goalstringT迭代目标，富文本
start_timeint64T计划开始时间 单位秒
end_timeint64T计划结束时间 单位秒
statusintF迭代状态: 1:未开始,2:进行中
3:已完成, 4:删除
create_timeint64F创建时间 单位秒
is_open_ganttboolT是否开启甘特图
fieldsarrayF迭代属性
statusesarrayF迭代阶段
periodstringF迭代周期 custom:自定义, 1w:1 周 2w:2 周 以此类推

API 说明​

1. 添加迭代​

URL​

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

HTTP Method​

POST

调用权限​

manage_sprints

传值方式​

JSON

参数列表​

参数名是否必须值类型取值范围说明
sprintsTarraysprint 列表，参考顶端 sprint 允许修改的字段

返回参数列表​

参数名值类型取值范围说明
sprintsarray[添加成功的 sprint]，参考顶端 sprint 说明
bad_sprintsarray添加失败的 sprint
  uuidarray失败的 id
  codearray失败的返回码
  descarray失败的原因描述
server_update_stampint64sprint 数据更新时间戳

返回的 HTTP status code​

状态码说明
200成功
500服务端异常
630找不到项目/文件夹不存在
801参数不合法

请求参数示例​

{
  "sprints": [
    {
      "title": "test_add_sprint",
      "assign": "6ZpgEzkk",
      "start_time": 1596384000,
      "end_time": 1599408000,
      "period": "1w",
      "statuses": [],
      "fields": []
    }
  ]
}

返回参数示例​

{
  "sprints": [
    {
      "uuid": "PqekjXz6",
      "title": "test_add_sprint",
      "project_uuid": "6ZpgEzkkmkvOVIU6",
      "title_pinyin": "test_add_sprint",
      "description": "",
      "start_time": 1596384000,
      "end_time": 1599494399,
      "status": 1,
      "create_time": 1597216996,
      "is_pin": false,
      "is_open_gantt": false,
      "daily_hours": 0,
      "assign": "6ZpgEzkk",
      "goal": "",
      "period": "1w",
      "fields": [
        {
          "field_uuid": "Ua9o7yUF",
          "type": "text",
          "name": "sprint_field_1",
          "value": null
        }
      ],
      "statuses": [
        {
          "status_uuid": "9eTpTcdk",
          "name": "未开始",
          "category": "to_do",
          "plan_start_time": 1596384000,
          "plan_end_time": null,
          "actual_start_time": null,
          "actual_end_time": null,
          "is_current_status": true,
          "desc_plain": "",
          "desc_rich": ""
        },
        {
          "status_uuid": "7KKSKYUq",
          "name": "进行中",
          "category": "in_progress",
          "plan_start_time": null,
          "plan_end_time": null,
          "actual_start_time": null,
          "actual_end_time": null,
          "is_current_status": false,
          "desc_plain": "",
          "desc_rich": ""
        },
        {
          "status_uuid": "AtV469fA",
          "name": "已完成",
          "category": "done",
          "plan_start_time": null,
          "plan_end_time": 1599494399,
          "actual_start_time": null,
          "actual_end_time": null,
          "is_current_status": false,
          "desc_plain": "",
          "desc_rich": ""
        }
      ],
      "progress": 0
    }
  ],
  "bad_sprints": [],
  "server_update_stamp": 1597216996322944
}

2. 更新迭代​

URL​

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

HTTP Method​

POST

调用权限​

manage_sprints

传值方式​

JSON

参数列表​

参数名是否必须值类型取值范围说明
sprintsTarraysprint 列表，参考顶端 sprint 允许修改的字段

返回参数​

参数名值类型取值范围说明
sprintsarray[添加成功的 sprint]，参考顶端 sprint 说明
bad_sprintsarray添加失败的 sprint
  uuidstring失败的 id
  codeint64失败的返回码
  descstring失败的原因描述
server_update_stampint64sprint 数据更新时间戳

HTTP status code​

老错误码说明(已被弃用，请参考新的错误码说明)：

状态码说明
200成功
500服务端异常
630找不到该 sprint/文件夹不存在
801某些必要字段为空
819没有修改 sprint 权限

新错误码说明：

http 状态码errcode说明
200成功
500ServerError服务器内部错误
400Malformed.JSON参数错误，json 解析错误
401AuthFailure.InvalidToken用户授权失败，比如登录失败或者 token 过期
403AccessDenied.Team用户没有权限访问 team
403PermissionDenied.ManageSprints用户没有管理迭代的权限
404NotFound.Sprint迭代不存在
400MissingParameter.SprintStatus缺少参数 SprintStatus
400MissingParameter.SprintStatus.UUID缺少参数 SprintStatus.UUID
403ConstraintViolation.MultipleCurrentStatus不能设置多个当前状态
400MissingParameter.SprintStatus.PlannedStartTime缺少参数 SprintStatus.PlannedStartTime
400MissingParameter.SprintStatus.PlannedEndTime缺少参数 SprintStatus.PlannedEndTime
403ConstraintViolation.EndTimeEarlierThanStartTime结束时间早于开始时间
403ConstraintViolation.SomeTasksNotDone还有未完成的任务

请求参数示例​

{
  "sprints": [
    {
      "title": "update sprint",
      "uuid": "QwdDfDGR"
    }
  ]
}

3. 删除迭代​

URL​

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

HTTP Method​

POST

调用权限​

manage_sprints

传值方式​

JSON

参数列表​

无

HTTP status code​

状态码说明
200成功
500服务端异常
620不存在该 sprintUUID
819没有删除 sprint 权限

返回参数​

参数名值类型取值范围说明
server_update_stampint64更新时间戳

4. 获取项目下当前用户可见的迭代列表​

URL​

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

HTTP Method​

GET

传值方式​

JSON

参数列表​

无

返回参数​

参数名值类型是否必填说明
sprints[]objectT迭代详情
  uuidstringFuuid
  project_uuidstringF所属项目 uuid
  titlestringT标题
  assignstringT负责人 uuid
  goalstringT迭代目标，富文本
  start_timeint64T计划开始时间 单位秒
  end_timeint64T计划结束时间 单位秒
  statusintF迭代状态: 1:未开始,2:进行中
3:已完成, 4:删除
  create_timeint64F创建时间 单位秒
  is_open_ganttboolT是否开启甘特图
  fieldsarrayF迭代属性
  statusesarrayF迭代阶段

返回值示例​

{
  "sprints": [
    {
      "uuid": "DHxogH7P",
      "title": "sprints_test",
      "project_uuid": "8dcHr1QQxE38jA4A",
      "title_pinyin": "sprints_test",
      "description": "",
      "start_time": 1576771200,
      "end_time": 1576943999,
      "status": 1,
      "create_time": 1573110417,
      "is_pin": false,
      "is_open_gantt": false,
      "daily_hours": 0,
      "assign": "8dcHr1QQ",
      "goal": "",
      "fields": [],
      "statuses": [
        {
          "status_uuid": "AS3Qeqti",
          "name": "未开始",
          "category": "to_do",
          "plan_start_time": 1576771200,
          "plan_end_time": null,
          "actual_start_time": null,
          "actual_end_time": null,
          "is_current_status": true,
          "desc_plain": "",
          "desc_rich": ""
        },
        {
          "status_uuid": "QY6wtX2g",
          "name": "进行中",
          "category": "in_progress",
          "plan_start_time": null,
          "plan_end_time": null,
          "actual_start_time": null,
          "actual_end_time": null,
          "is_current_status": false,
          "desc_plain": "",
          "desc_rich": ""
        },
        {
          "status_uuid": "FmfdvUUT",
          "name": "已完成",
          "category": "done",
          "plan_start_time": null,
          "plan_end_time": 1576943999,
          "actual_start_time": null,
          "actual_end_time": null,
          "is_current_status": false,
          "desc_plain": "",
          "desc_rich": ""
        }
      ]
    }
  ],
  "server_update_stamp": 1573110417742544
}

5. 获取团队中所有迭代详情​

URL​

https://your-host-name/project/api/project/team/:teamUUID/sprints/all

HTTP Method​

GET

传值方式​

JSON

参数列表​

无

返回参数​

参数名值类型是否必填说明
sprints[]objectT迭代详情
  uuidstringFuuid
  project_uuidstringF所属项目 uuid
  titlestringT标题
  assignstringT负责人 uuid
  goalstringT迭代目标，富文本
  start_timeint64T计划开始时间 单位秒
  end_timeint64T计划结束时间 单位秒
  statusintF迭代状态: 1:未开始,2:进行中
3:已完成, 4:删除
  create_timeint64F创建时间 单位秒
  is_open_ganttboolT是否开启甘特图
  fieldsarrayF迭代属性
  statusesarrayF迭代阶段

返回值示例​

{
  "sprints": [
    {
      "uuid": "DHxogH7P",
      "title": "sprints_test",
      "project_uuid": "8dcHr1QQxE38jA4A",
      "title_pinyin": "sprints_test",
      "description": "",
      "start_time": 1576771200,
      "end_time": 1576943999,
      "status": 1,
      "create_time": 1573110417,
      "is_pin": false,
      "is_open_gantt": false,
      "daily_hours": 0,
      "assign": "8dcHr1QQ",
      "goal": "",
      "fields": [],
      "statuses": [
        {
          "status_uuid": "AS3Qeqti",
          "name": "未开始",
          "category": "to_do",
          "plan_start_time": 1576771200,
          "plan_end_time": null,
          "actual_start_time": null,
          "actual_end_time": null,
          "is_current_status": true,
          "desc_plain": "",
          "desc_rich": ""
        },
        {
          "status_uuid": "QY6wtX2g",
          "name": "进行中",
          "category": "in_progress",
          "plan_start_time": null,
          "plan_end_time": null,
          "actual_start_time": null,
          "actual_end_time": null,
          "is_current_status": false,
          "desc_plain": "",
          "desc_rich": ""
        },
        {
          "status_uuid": "FmfdvUUT",
          "name": "已完成",
          "category": "done",
          "plan_start_time": null,
          "plan_end_time": 1576943999,
          "actual_start_time": null,
          "actual_end_time": null,
          "is_current_status": false,
          "desc_plain": "",
          "desc_rich": ""
        }
      ]
    }
  ],
  "server_update_stamp": 1573110417742544
}
Last updated on