如何通过Jira REST API配置仪表板Filter Results小工具参数

创建小工具专属配置不需要在创建接口传参，创建空白实例后调用更新接口写入配置即可，操作流程如下：

• 第一步：调用POST /rest/api/3/dashboard/{dashboardId}/gadget 接口创建Filter Results类型空白小工具，保存接口返回的gadgetId字段值。
• 第二步：整理小工具专属配置，所有专属参数都放在请求体的properties对象中，三个核心配置对应的字段如下：
  • Saved filter（已保存筛选器）：对应字段filterId，传入目标筛选器的数字ID
  • Number of results（结果条数）：对应字段num，传入整数类型的条数数值，比如要展示20条就传20
  • Columns to display（显示列）：对应字段columnNames，传入按展示顺序排列的字段标识数组，常见字段标识比如issuetype（问题类型）、issuekey（问题键）、summary（摘要）、assignee（经办人）、status（状态）
• 第三步：调用PUT /rest/api/3/dashboard/{dashboardId}/gadget/{gadgetId} 接口提交配置，请求体除了properties外，还需要带上小工具的moduleKey（Filter Results类型固定为com.atlassian.jira.gadgets:filterresults-gadget）、位置、配色等基础参数。

请求体示例：

{
  "moduleKey": "com.atlassian.jira.gadgets:filterresults-gadget",
  "position": {
    "column": 0,
    "row": 0
  },
  "color": "default",
  "properties": {
    "filterId": 10024,
    "num": 15,
    "columnNames": ["issuetype", "issuekey", "summary", "priority", "assignee", "status", "updated"]
  }
}

排查配置字段的小技巧：如果不确定某类小工具的配置字段名，可以先在Jira前端手动配置好一个同类型的小工具，再调用GET /rest/api/3/dashboard/{dashboardId}/gadget/{gadgetId} 拉取该小工具的完整返回结果，直接参考返回的properties结构构造参数即可，不需要硬记字段名。

内容的提问来源于stack exchange，提问作者Chiamin