Skip to main content

Sprint field

danger

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

模型

迭代属性​

sprint_field

参数名类型说明
uuidstring属性 id
namestring属性名
typestring属性类型
optionsarray选项
  valuestring选项值

迭代属性值​

sprint_field_value

参数名类型说明
field_uuidstring属性 id
namestring属性名
typestring属性类型
valueint/string属性值

属性类型​

type

类型值类型说明
optionstring选项，值是当前选中的选项 u
textstring文本
multi_line_textstring多行文本
integerint64整数，值 = 实际数值 x 100
floatint64浮点数，值 = 向下取整(实际 x 100000)，小数点后有效位数 5 位
dateint64日期，utc 时间戳，以秒为单
timeint64时间，utc 时间戳，以秒为单
userstring团队内成员，值是用户 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

请求参数​

参数名类型是否必填说明
fieldobjectT属性
  uuidstringF属性 id,程序生成不需要填写
  namestringT属性名
  typestringT属性类型
  optionsarrayF选项
    valuestringF选项值

返回参数​

参数名类型是否必填说明
fieldobjectT属性
  uuidstringF属性 id 程序生成
  namestringT属性名
  typestringT属性类型
  optionsarrayF选项
    valuestringF选项值
server_update_stampintT数据更新时间（微妙）

请求体示例​

{
  "field": {
    "name": "optionsName",
    "type": "option",
    "options": [
      {
        "value": "aa"
      },
      {
        "value": "bb"
      },
      {
        "value": "cc"
      }
    ]
  }
}

返回值示例​

{
  "field": {
    "uuid": "GMeL5qUm",
    "name": "optionsName",
    "type": "option",
    "default_value": null,
    "default_value_type": "default",
    "built_in": false,
    "options": [
      {
        "uuid": "85yjp9FH",
        "value": "aa",
        "selected": false
      },
      {
        "uuid": "JEp1hct9",
        "value": "bb",
        "selected": false
      },
      {
        "uuid": "HmVo4twR",
        "value": "cc",
        "selected": false
      }
    ],
    "required": false,
    "can_modify_required": false
  },
  "server_update_stamp": 1648720066672304
}

2.修改项目下迭代属性​

URL​

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

HTTP Method​

POST

是否需要登录​

是

调用权限​

manage_sprints

请求参数​

参数名类型是否必填说明
fieldobjectT属性
  uuidstringT属性 id
  namestringT属性名
  typestringT属性类型
  optionsarrayF选项
    valuestringF选项值

返回参数列表​

参数名类型是否必填说明
    valuestringF选项值

请求体示例​

{
  "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[]objectT属性
  uuidstringT属性 id
  namestringT属性名
  typestringT属性类型
  optionsarrayT选项

请求体示例​

无

返回值示例​

{
  "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_valueobjectT只需要传 value

请求参数参考​

{
  "field_value": {
    "value": "newValue, option 类型传选项的 uuid"
  }
}

返回值示例​

{
  "server_update_stamp": 1594378116861072
}
Last updated on