场景
有时候我们我们在JIRA中定义的选择类字段,这些信息需要经常与第三方一致,包括新增、禁用、修改等,避免两边系统同步不及时 等情况
这里提供的功能是接口的方式,允许调用接口来维护这些字段的值 。
功能
可以创建、禁用、启用、修改选择类字段的选择项
这些选择类字段的值如果存在适应的上下文(项目、问题类型 ),也可以单项修改
JIRA配置
选择类的字段可以配置上下文,比如DEMO上下文应用于DEMO项目,也存在全局的上下文学
我们可以进行相信息的维护
创建接口
接口方法
POST
地址
/rest/custom/1.0/customfield/createOption
Body
{ |
---|
Body说明
项 | 值 | 说明 |
---|---|---|
value | 文本 | 选择类的值,用于显示的选项值 |
disabled | boolean | 创建后是启用还是禁用,true为禁用,false为启用 |
customFieldId | 整值 | 选择类自定义字段的ID |
projectIds | 数字队列 | 项目ID队列,主要应用于判定创建的值是应用于哪一个上下方案,如果方案中包括这个项目的配置,那么将此选择值增加至此上下文方案中 如果此值不填写,将默认增加到全局上下文中 |
返回结果
[ { "id": 10114, "value": "平台系统A", "disabled": false, "self": "http://localhost:2990/jira/rest/api/2/option/10114", "projectId": 10101 }, { "id": 10115, "value": "平台系统A", "disabled": false, "self": "http://localhost:2990/jira/rest/api/2/option/10115", "projectId": 10100 } ] |
---|
结果说明
项 | 值 | 说明 |
---|---|---|
ID | 数字 | 生成Option的内部ID值 |
value | 文本 | 与参数body的value值一致 |
disabled | boolean | 创建后是启用还是禁用,true为禁用,false为启用 |
self | url | 创建后查询此Option详情的调用地址 |
projectId | 数字 | 如果是建在上下文中,此Option表明它是在哪一个项目下的,此值只有在Body中projectIds会值是才会有 |
更新接口
接口方法
POST
地址
/rest/custom/1.0/customfield/updateOption
Body
{ |
---|
参数说明
项 | 值 | 说明 |
---|---|---|
ID | 数字 | Option的内部ID值 |
value | 文本 | 需要将Option的选项值修改的目标值 |
disabled | boolean | 是否对之禁用||启用,true为禁用,false为启用 |
返回结果
{ |
---|
结果说明
项 | 值 | 说明 |
---|---|---|
ID | 数字 | Option的内部ID值 |
value | 文本 | 与参数body的value值一致 |
disabled | boolean | 创建后是启用还是禁用,true为禁用,false为启用 |
self | url | 创建后查询此Option详情的调用地址 |
级联接口
有时候选择类有级联,此时可以在创建的接口中增加其它的参数
Body
{ |
---|
Body说明
项 | 值 | 说明 |
---|---|---|
value | 文本 | 选择类的值,用于显示的选项值 |
disabled | boolean | 创建后是启用还是禁用,true为禁用,false为启用 |
customFieldId | 整值 | 选择类自定义字段的ID |
projectIds | 数字队列 | 项目ID队列,主要应用于判定创建的值是应用于哪一个上下方案,如果方案中包括这个项目的配置,那么将此选择值增加至此上下文方案中 如果此值不填写,将默认增加到全局上下文中 |
parentId | 整值 | 父选择的ID值 |
返回结果
[ |
---|
结果说明
项 | 值 | 说明 |
---|---|---|
ID | 数字 | 生成Option的内部ID值 |
value | 文本 | 与参数body的value值一致 |
disabled | boolean | 创建后是启用还是禁用,true为禁用,false为启用 |
self | url | 创建后查询此Option详情的调用地址 |
projectId | 数字 | 如果是建在上下文中,此Option表明它是在哪一个项目下的,此值只有在Body中projectIds会值是才会有 |
parentId | 整值 | 父选择的ID值 |