求助:如何通过Jira API在Kanban看板中创建自定义列?
Jira API 创建Kanban自定义列的实现方法
核心逻辑说明
Jira Kanban的列并非独立实体,而是**工作流状态(Status)**在看板上的可视化分组。添加自定义列(如"In Testing")需要完成两个核心步骤:创建对应工作流状态,再将该状态关联到看板的列配置中。
步骤1:创建新的工作流状态
使用Jira REST API的状态创建端点:
- 请求方法:
POST - 端点:
/rest/api/3/status - 请求体示例:
{ "name": "In Testing", "description": "Issue is under testing phase", "category": "IN_PROGRESS" // 可选值:TODO, IN_PROGRESS, DONE,对应看板列的分组类型 }
- 注意:需将该状态添加到项目关联的工作流中,若使用共享工作流,需通过工作流更新API完成状态添加操作。
步骤2:将状态添加到Kanban看板的列中
Kanban看板的列配置通过boardConfiguration API管理,分两步操作:
获取看板当前配置
- 请求方法:
GET - 端点:
/rest/agile/1.0/board/{boardId}/configuration - 响应里的
columnConfig字段会返回当前所有列及对应的状态ID列表。
- 请求方法:
更新看板列配置
- 请求方法:
PUT - 端点:
/rest/agile/1.0/board/{boardId}/configuration - 请求体示例(新增"In Testing"列):
- 请求方法:
{ "columnConfig": { "columns": [ { "name": "To Do", "statuses": ["10000"] // 替换为实际To Do状态的ID }, { "name": "In Progress", "statuses": ["10001"] // 替换为实际In Progress状态的ID }, { "name": "In Testing", "statuses": ["10005"] // 替换为步骤1中创建的状态ID }, { "name": "Done", "statuses": ["10002"] // 替换为实际Done状态的ID } ], "constraintType": "NONE" } }
- 注意:替换
{boardId}为目标看板的ID,所有状态ID需替换为实际值。
常见注意事项
- 操作需具备Jira Software看板管理权限及工作流修改权限(若涉及共享工作流)。
- API请求需携带有效认证信息(如API Token或OAuth2凭证)。
- 若看板设置了WIP等列约束,更新配置时需保留对应约束字段。
内容的提问来源于stack exchange,提问作者Yashpal Rathore
相关产品推荐
相关产品推荐

