通过JIRA API

时间:2017-09-20 18:55:26

标签: jira jira-rest-api

我正在创建一个报告信息中心,目的是获取项目的多个故障单/问题。正如大多数人可能知道的那样,JIRA问题可以有子任务。这些子任务可以有标签。

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

我已经实施了项目API请求,该请求返回父票证ID以及所有子任务的问题/票证号码。问题是从此请求返回的数据不包括子任务本身的标签。

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

通过JIRA的API,我无法找到更好的方法。谷歌似乎通过云端服务器返回了很多关于插件和版本差异的结果,但我还没有找到更好的解决方案。

他们的API引用了一个扩展选项,但我还没有找到一种方法来使子树标签工作(我可能会遗漏一些明显的东西)。

如果有人有类似情况的经验,我将不胜感激听到您提供的任何建议。谢谢!

我目前的情况:

Project API请求:

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

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

project=PROJECTNAME AND fixversion=version

这将返回项目中包含子任务但不包含子任务标签的所有票证。

我可以循环上述请求中的返回数据,并为每个请求发出一个额外的请求:

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
               }
            }
         }
      ]
   }

2 个答案:

答案 0 :(得分:0)

再次检查/search端点的响应。在一个完全空的JIRA Cloud实例上,我创建了一个Project,一个Issue并为其添加了一个Sub-task。调用/search端点会返回一个包含两个问题的列表(因此,问题本身及其子任务),并且两个都有一个名为标签的字段,其中包含附加到所有标签的数组它

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

{
  "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]请求
  • 这些特定密钥的/search

答案 1 :(得分:0)

在做了一些进一步的研究之后,我发现了一种更好的方法。我仍然没有得到子任务标签,但是不是循环每个子任务并为每个子任务发送单独的请求,你可以使用JQL进行一次API调用,如下所示:

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

  

&安培;字段=标签

部分大幅减少了返回的信息量。所以现在我可以一共做两次电话并获得我需要的一切。 :)

如果有人遇到类似情况,请发布此信息。