目录
模型
迭代属性
sprint_field
| 参数名 | 类型 | 说明 |
|---|---|---|
| uuid | string | 属性id |
| name | string | 属性名 |
| type | string | 属性类型 |
| options | array | 选项 |
| value | string | 选项值 |
迭代属性值
sprint_field_value
| 参数名 | 类型 | 说明 |
|---|---|---|
| field_uuid | string | 属性id |
| name | string | 属性名 |
| type | string | 属性类型 |
| value | int/string | 属性值 |
属性类型
type
| 类型 | 值类型 | 说明 |
|---|---|---|
| option | string | 选项，值是当前选中的选项 u |
| text | string | 文本 |
| integer | int64 | 整数，值 = 实际数值 x 100 |
| float | int64 | 浮点数，值 = 向下取整(实际 x 100000)，小数点后有效位数 5 位 |
| date | int64 | 日期，utc 时间戳，以秒为单 |
| time | int64 | 时间，utc 时间戳，以秒为单 |
| user | string | 团队内成员，值是用户 uuid |
状态码说明
| 状态码 | 说明 |
|---|---|
| 200 | 成功 |
| 403 | 没权限 |
| 500 | 服务器内部错 |
| 630 | 找不到对应数 |
| 801 | 参数不合法 |
API说明
1.添加项目下迭代属性
URL
https://your-host-name/project/api/project/team/:teamUUID/project/:projectUUID/sprint_fields/add
HTTP Method
POST
是否需要登录
是
调用权限
manage_sprints
请求参数
| 参数名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| field | object | T | 属性 |
| uuid | string | F | 属性id,程序生成不需要填写 |
| name | string | T | 属性名 |
| type | string | T | 属性类型 |
| options | array | F | 选项 |
| value | string | F | 选项值 |
返回参数
| 参数名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| field | object | T | 属性 |
| uuid | string | F | 属性id 程序生成 |
| name | string | T | 属性名 |
| type | string | T | 属性类型 |
| options | array | F | 选项 |
| value | string | F | 选项值 |
| server_update_stamp | int | T | 数据更新时间（微妙） |
请求体示例
{
"field": {
"name": "optionsName",
"type": "option",
"options": [{
"value": "aa"
}, {
"value": "bb"
}, {
"value": "cc"
}]
}
}
返回值示例
{
"field": {
"uuid": "5nknReY2",
"name": "optionsName",
"type": "option",
"options": [{
"uuid": "EfPrwc7C",
"value": "aa",
"selected": false
}, {
"uuid": "WnPt1XR8",
"value": "bb",
"selected": false
}, {
"uuid": "JBhCLAWF",
"value": "cc",
"selected": false
}]
},
"server_update_stamp": 1594377112434672
}
2.修改项目下迭代属性
URL
https://your-host-name/project/api/project/team/:teamUUID/project/:projectUUID/sprint_field/:fieldUUID/update
HTTP Method
POST
是否需要登录
是
调用权限
manage_sprints
请求参数
| 参数名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| field | object | T | 属性 |
| uuid | string | T | 属性id |
| name | string | T | 属性名 |
| type | string | T | 属性类型 |
| options | array | F | 选项 |
| value | string | F | 选项值 |
返回参数列表
| 参数名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| value | string | F | 选项值 |
请求体示例
{
"field": {
"uuid": "5nknReY2",
"name": "updatOptionsName",
"type": "option",
"options": [{
"uuid": "EfPrwc7C",
"value": "aa",
"selected": false
}, {
"uuid": "WnPt1XR8",
"value": "bb",
"selected": false
}, {
"uuid": "JBhCLAWF",
"value": "cc",
"selected": false
}]
}
}
返回值示例
{
"server_update_stamp": 1594377519830304
}
3.删除项目下迭代属性
删除操作将会一并删除已有迭代的该项属性内容，此操作不可撤销
URL
https://your-host-name/project/api/project/team/:teamUUID/project/:projectUUID/sprint_field/:fieldUUID/delete
HTTP Method
POST
是否需要登录
是
调用权限
manage_sprints
请求参数
无
请求体示例
无
返回值示例
{
"server_update_stamp": 1565943793853952
}
4.获取项目下迭代属性列表
URL
https://your-host-name/project/api/project/team/:teamUUID/project/:projectUUID/sprint_fields
HTTP Method
GET
是否需要登录
调用权限
BrowseProject
请求参数
无
返回参数列表
| 参数名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| fields | []object | T | 属性 |
| uuid | string | T | 属性id |
| name | string | T | 属性名 |
| type | string | T | 属性类型 |
| options | array | T | 选项 |
请求体示例
无
返回值示例
{
"fields": [{
"uuid": "SY2XZe8H",
"name": "迭代属性名称",
"type": "text",
"options": null
}]
}
5.修改迭代属性值
https://your-host-name/project/api/project/team/:teamUUID/project/:projectUUID/sprint/:sprintUUID/sprint_field/:fieldUUID/update
HTTP Method
POST
是否需要登录
是
调用权限
manage_sprints
请求参数
| 参数名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| field_value | object | T | 只需要传 value |
请求参数参考
{
"field_value": {
"value": "setedValue"
}
}
返回值示例
{
"server_update_stamp": 1594378116861072
}