通过REST API查询JIRA以及查询中可能存在的错误值

时间:2017-07-25 19:39:19

标签: python rest jira-rest-api jql

我有一个门户用户可以访问基于cherrypy的访问,其中包含一些可以提交的表单,这些表单将通过REST API发送到JIRA以进行跟踪。提交后,我会从表单和JIRA问题ID中获取用户提供的信息,并将其发送到oracle DB。

同样,我随后扩展了门户网站的功能,以便能够通过列表页面查看用户提交的内容,然后选择一条记录来查看该提交的数据库中存储的内容。我有一个想法,然后使用REST API for JIRA来获取JIRA中问题的状态和受让人。转换我的代码以提交给API,而不是使用必要的JQL语句查询它是相当简单的,可以在下面看到。

def jira_status_check(jira_id):
if jira_id != "No JIRA Issue":
    try:
        search_url = "https://myjirainstance.atlassian.net/rest/api/2/search/?jql=issue=" + jira_id + "&fields=status,assignee,resolution"
        print search_url
        username = 'some_user'
        password = 'some_password'
        request = urllib2.Request(search_url)
        base64string = base64.encodestring('%s:%s' % (username, password)).replace('\n', '')
        request.add_header("Authorization", "Basic %s" % base64string)
        request.add_header("Content-Type", "application/json")
        result = urllib2.urlopen(request).read()
        json_results = json.loads(result)
        print json_results
        jira_status = json_results["issues"][0]["fields"]["status"]["name"]
        if json_results["issues"][0]["fields"]["resolution"] is None:
            tmp = "tmp"
        if json_results["issues"][0]["fields"]["resolution"] is not None:
            jira_status = jira_status + " - " + json_results["issues"][0]["fields"]["resolution"]["name"]
        # assignee_name = "TEST"
        # assignee_NT = "TEST"
        if json_results["issues"][0]["fields"]["assignee"] is None:
            assignee_name = "Unassigned"
            assignee_NT = "Unassigned"
        if json_results["issues"][0]["fields"]["assignee"] is not None:
            assignee_name = json_results["issues"][0]["fields"]["assignee"]["displayName"]
            assignee_NT = json_results["issues"][0]["fields"]["assignee"]["name"]
        # if json_results["issues"][0]["fields"]["assignee"]["displayName"] is not None:
        #     assignee_name = json_results["issues"][0]["fields"]["assignee"]["displayName"]
        # if json_results["issues"][0]["fields"]["assignee"] is None:
        #     assignee_NT = "Unassigned"
        # if json_results["issues"][0]["fields"]["assignee"]["name"] is not None:
        #     assignee_NT = json_results["issues"][0]["fields"]["assignee"]["name"]
        print jira_status
        print assignee_name
        print assignee_NT
        output = [jira_status, assignee_name, assignee_NT]
    except:
        jira_status = "No JIRA Issue by that number or JIRA inaccessible"
        assignee_name = "No JIRA Issue by that number or JIRA inaccessible"
        assignee_NT = "No JIRA Issue by that number or JIRA inaccessible"
        output = [jira_status, assignee_name, assignee_NT]
else:
    jira_status = "No JIRA Issue"
    assignee_name = "No JIRA Issue"
    assignee_NT = "No JIRA Issue"
    output = [jira_status, assignee_name, assignee_NT]
return output

然而,它仅限于一次搜索单个记录,当您只查看单个记录时,该记录有效,但我希望将此扩展到我的列表页面并使用一个api查询一次搜索多个而不是大量的单一问题查询。我能够使用jql和其他API在这样的链接上搜索多个问题编号https://myjirainstance.atlassian.net/rest/api/2/search/?jql=Issue%3DSPL-3284%20OR%20Issue%3DSPL-3285&fields=status,assignee,resolution

但是后来我想到了如果以某种方式保存了错误的问题ID并将其作为大量查询的一部分进行查询的话。以前,当我的jira_status_check函数是单个记录查询时,它是使用except语句处理的。当我尝试使用像最后一个共享的链接查询其余的api而不是

 {"errorMessages":["An issue with key 'SPL-6666' does not exist for field 'Issue'."],"warningMessages":[]}

我尝试根据问题的高级搜索构建查询,但当我执行Issue=SPL-3284 OR Issue=SPL-3285 OR Issue=SPL-6666之类的操作时,我收到了An issue with key 'SPL-6666' does not exist for field 'Issue'.

的回复

是否有正确的方法通过JQL搜索多个问题编号,并且没有匹配问题编号的字段的字段没有返回值?

或者我是否坚持要对api进行大量的单一问题查询来覆盖我的基地?这可能不太理想,并且可能会导致我只是将api查询限制为查看单个记录而不是列表页面以获得可用性。

我会更好地移动我的函数来查询JIRA到javascript / jquery,它可以在呈现页面后填充提交列表吗?

1 个答案:

答案 0 :(得分:1)

我最后通过我关于JQL的问题与Atlassian联系,然后给出了以下其余的api文档,并告诉我要添加到我的JQL以实现我的搜索的validateQuery参数。 https://docs.atlassian.com/jira/REST/6.1.7/

当我现在在我的rest api链接上使用与我的附加参数

类似的查询时

jql=Issue%3DSPL-3284 OR Issue%3DSPL-3285&fields=status,assignee,resolution&validateQuery=true

我找回了一个JSON,其中包含有效问题的实际内容,然后是一个单独的warningMessages对象,其中包含任何不好的问题。下面是一个示例JSON,但显然$ CONTENT将是来自查询的实际结果

{
  "expand": "schema,names",
  "startAt": 0,
  "maxResults": 50,
  "total": 2,
  "issues": [
    {
      $CONTENT
    },
    {
      $CONTENT
    }
  ],
  "warningMessages": [
    "An issue with key 'SPL-6666' does not exist for field 'Issue'."
  ]
}

希望其他人会在将来发现这有用