通过 JIRA 从多个 JIRA 子任务中检索标签 API

Question

我正在创建一个报告仪表板，目的是为一个项目获取多个 tickets/issues。大多数人可能都知道，JIRA 问题可以有子任务。这些子任务可以有标签。

我想检索每个子任务的所有标签。

我已经实现了项目 API 请求，其中 return 父工单 ID 以及所有子任务的 issue/ticket 数量。问题是从该请求中 return 编辑的数据不包括子任务本身的标签。

我可以遍历每个子任务编号并为每个子任务编号发出额外的 API 请求以获取标签，但是这会导致大量请求。

查看 JIRA 的 API 我找不到更好的方法。 Google 似乎 return 有很多关于插件和云与服务器的版本差异的结果，但我还没有找到更好的解决方案。

他们的 API 引用了一个扩展选项，但我还没有想出一种方法来使它适用于子任务标签（我可能遗漏了一些明显的东西）。

如果有人有类似情况的经验，我将不胜感激听到你能提供的任何建议。谢谢！

我目前拥有的：

项目API请求：

https://ourcompanyhere.atlassian.net/rest/api/2/search

为 JQL 字符串添加了一个附加参数：

project=PROJECTNAME AND fixversion=version

这 return 项目中所有带有子任务但没有子任务标签的工单。

我可以遍历来自上述请求的 returned 数据，并为每个请求额外请求：

https://ourcompanyhere.atlassian.net/rest/api/2/issue/ticketNumberHere

JSON响应

这是部分 JSON 回复（完整回复很大，我已经删除了关键信息）但是这是工单的完整信息，其中有一个带有标签的子任务。如您所见，子任务 的标签部分完全缺失。

ErrorDetail=,
   Mimetype=application/json,
   Statuscode=200 OK,
   Filecontent=   {
      "expand":"schema,names",
      "startAt":0,
      "maxResults":50,
      "total":3,
      "issues":[
         {
            "expand":"operations,versionedRepresentations,editmeta,changelog,renderedFields",
            "id":"24209",
            "self":"https://[instance].atlassian.net/rest/api/latest/issue/24209",
            "key":"DEV-3089",
            "fields":{
               "issuetype":{
                  "self":"https://[instance].atlassian.net/rest/api/2/issuetype/10005",
                  "id":"10005",
                  "description":"A new feature of the product, which has yet to be developed.",
                  "iconUrl":"https://[instance].atlassian.net/secure/viewavatar?size=xsmall&avatarId=10311&avatarType=issuetype",
                  "name":"New Feature",
                  "subtask":false,
                  "avatarId":10311
               },
               "project":{
                  "self":"https://[instance].atlassian.net/rest/api/2/project/10000",
                  "id":"10000",
                  "key":"DEV",
                  "name":"Development Queue",
                  "avatarUrls":{                  
                  }
               },
               "customfield_11000":null,
               "fixVersions":[
                  {
                     "self":"https://[instance].atlassian.net/rest/api/2/version/14600",
                     "id":"14600",
                     "description":"",
                     "name":"",
                     "archived":false,
                     "released":true,
                     "releaseDate":"2017-09-15"
                  }
               ],
               "resolution":{
                  "self":"https://[instance].atlassian.net/rest/api/2/resolution/10000",
                  "id":"10000",
                  "description":"Work has been completed on this issue.",
                  "name":"Done"
               },
               "customfield_10500":"",
               "customfield_10700":null,
               "customfield_10900":null,
               "resolutiondate":"2017-09-15T09:19:37.000-0400",
               "workratio":-1,
               "watches":{
                  "self":"https://[instance].atlassian.net/rest/api/2/issue/DEV-3089/watchers",
                  "watchCount":2,
                  "isWatching":true
               },
               "lastViewed":null,
               "created":"2017-05-02T10:15:08.000-0400",
               "customfield_10022":null,
               "customfield_10100":null,
               "priority":{
                  "self":"https://[instance].atlassian.net/rest/api/2/priority/3",
                  "iconUrl":"https://[instance].atlassian.net/images/icons/priorities/medium.svg",
                  "name":"Medium",
                  "id":"3"
               },
               "customfield_10300":null,
               "labels":[
                  "[label1]",
                  "[label2]",
                  "[label3]",
                  "[label4]",
                  "[label5]",
                  "[label6]"
               ],
               "customfield_10016":null,
               "customfield_10017":null,
               "versions":[

               ],
               "issuelinks":[

               ],
               "assignee":{
                  "self":"https://[instance].atlassian.net/rest/api/2/user?username=",
                  "name":"[name]",
                  "key":"[name]",
                  "accountId":"[account]",
                  "emailAddress":"[email]",
                  "avatarUrls":{
                  },
                  "displayName":"[name]",
                  "active":true,
                  "timeZone":"America/New_York"
               },
               "updated":"2017-09-15T09:19:36.000-0400",
               "status":{
                  "self":"https://[instance].atlassian.net/rest/api/2/status/6",
                  "description":"The issue is considered finished, the resolution is correct. Issues which are closed can be reopened.",
                  "iconUrl":"https://[instance].atlassian.net/images/icons/statuses/closed.png",
                  "name":"Closed",
                  "id":"6",
                  "statusCategory":{
                     "self":"https://[instance].atlassian.net/rest/api/2/statuscategory/3",
                     "id":3,
                     "key":"done",
                     "colorName":"green",
                     "name":"Done"
                  }
               },
               "components":[

               ],
               "description":"[description]",
               "customfield_10010":null,
               "customfield_10011":null,
               "customfield_11100":null,
               "customfield_10012":null,
               "customfield_10013":null,
               "customfield_10015":"",
               "customfield_10005":null,
               "customfield_10006":null,
               "customfield_10600":null,
               "customfield_10007":null,
               "customfield_10008":null,
               "customfield_10800":null,
               "customfield_10009":null,
               "summary":"[summary]",
               "creator":{
                  "self":"https://[instance].atlassian.net/rest/api/2/user?username=",
                  "name":"",
                  "key":"",
                  "accountId":"",
                  "emailAddress":"",
                  "avatarUrls":{
                  },
                  "displayName":"",
                  "active":true,
                  "timeZone":"America/New_York"
               },
               "subtasks":[
                  {
                     "id":"30213",
                     "key":"DEV-4118",
                     "self":"https://[instance].atlassian.net/rest/api/2/issue/30213",
                     "fields":{
                        "summary":"",
                        "status":{
                           "self":"https://[instance].atlassian.net/rest/api/2/status/6",
                           "description":"The issue is considered finished, the resolution is correct. Issues which are closed can be reopened.",
                           "iconUrl":"https://[instance].atlassian.net/images/icons/statuses/closed.png",
                           "name":"Closed",
                           "id":"6",
                           "statusCategory":{
                              "self":"https://[instance].atlassian.net/rest/api/2/statuscategory/3",
                              "id":3,
                              "key":"done",
                              "colorName":"green",
                              "name":"Done"
                           }
                        },
                        "priority":{
                           "self":"https://[instance].atlassian.net/rest/api/2/priority/3",
                           "iconUrl":"https://[instance].atlassian.net/images/icons/priorities/medium.svg",
                           "name":"Medium",
                           "id":"3"
                        },
                        "issuetype":{
                           "self":"https://[instance].atlassian.net/rest/api/2/issuetype/10009",
                           "id":"10009",
                           "description":"",
                           "iconUrl":"https://[instance].atlassian.net/secure/viewavatar?size=xsmall&avatarId=10303&avatarType=issuetype",
                           "name":"Testing Issue",
                           "subtask":true,
                           "avatarId":10303
                        }
                     }
                  }
               "reporter":{
                  "self":"https://[instance].atlassian.net/rest/api/2/user?username=",
                  "name":"",
                  "key":"",
                  "accountId":"",
                  "emailAddress":"",
                  "avatarUrls":{

                  },
                  "displayName":"",
                  "active":true,
                  "timeZone":"America/New_York"
               },
               "customfield_10000":"2017-09-01T12:35:54.706-0400",
               "customfield_10001":null,
               "customfield_10200":null,
               "customfield_10400":null,
               "customfield_10004":null,
               "environment":null,
               "duedate":null,
               "votes":{
                  "self":"https://[instance].atlassian.net/rest/api/2/issue/DEV-3089/votes",
                  "votes":0,
                  "hasVoted":false
               }
            }
         }
      ]
   }

Answer 1

再次检查 /search 端点的响应。在一个完全空的 JIRA Cloud 实例上，我创建了一个项目，一个问题并为其添加了一个子任务。调用 /search 端点 returns 一个包含两个问题的列表（因此，问题本身及其子任务）并且对于这两个问题都有一个名为 labels 的字段附加到它的所有标签的数组。

以下是删除了所有不相关数据的简短回复。

{
  "startAt": 0,
  "maxResults": 50,
  "total": 2,
  "issues": [
    {
      "key": "TEST-1",
      "fields": {
        "labels": []
      }
    },
    {
      "key": "TEST-2",
      "fields": {
        "parent": {
          "key": "TEST-1"
        },
        "labels": [
          "VOILA"
        ]
      }
    }
  ]
}

编辑

看了回复是的，subtasks里面的数组真的很简单，不能单独展开。您需要进行搜索，然后解析出您感兴趣的所有子任务，然后执行

每个单独的 /issue/[key] 请求
a /search 用于那些特定的键

Answer 2

经过进一步研究后，我发现了一种更好的方法。我仍然没有取回子任务标签，而不是遍历每个子任务并为每个子任务发送一个单独的请求，您可以使用 JQL 进行一次 API 调用，如下所示：

https://[instance].atlassian.net/rest/api/latest/search?jql=project=[project] AND KEY IN ([comma separated list of tickets])&fields=labels'

&fields=labels

part 大大减少了返回的信息量。所以现在我总共只需要打两个电话就可以得到我需要的一切。 :)

想要post这个以防有人遇到类似情况。

通过 JIRA 从多个 JIRA 子任务中检索标签 API

Retrieving labels from multiple JIRA Subtasks via JIRA API

jira

jira-rest-api