如何从Jira REST API获取一段时间的所有工作日志?

时间:2012-10-08 06:04:18

标签: rest jira

我正在编写一个使用PHP和Jira REST API的应用程序,该API需要在特定时间段内生成报告,并累积一个人在特定项目上花费的时间。

为此,我需要一个会给出类似内容的电话。

例如:For the period 01/01/2012 - 31/01/2012 give me the worklogs for project X.

我到目前为止找到的方法是在开始日期之后获取更新的问题,并再次按期间过滤每个问题的工作日志。

有更好的选择吗?

4 个答案:

答案 0 :(得分:3)

如果你找不到能满足你要求的开箱即用功能,我可以考虑除你以外的其他三种解决方案:

  1. Query the DB directly因此您可以使用一个查询获取工作日志。请确保不要直接插入/删除/更新数据库,而只是查询它。
  2. 使用Jira Scripting SuiteBehaviours Plugin之类的内容添加将在磁盘上的某处写入工作日志的脚本。然后使用另一个应用程序从磁盘读取书面信息并将其显示给用户。
  3. 使用Tempo plugin

答案 1 :(得分:3)

正如许多人所说,没有直接的方法。但是,如果您有效地缩小搜索空间范围,那就不那么糟糕了。以下PHP代码在我的设置上运行得非常快,但当然,您的里程可能会有所不同:

<?php
$server   = 'jira.myserver.com';
$fromDate = '2012-01-01';
$toDate   = '2012-01-31';
$project  = 'X';
$assignee = 'bob';

$username = 'my_name';
$password = 'my_password';

$curl = curl_init();
curl_setopt($curl, CURLOPT_USERPWD, "$username:$password");
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_FOLLOWLOCATION, 1);
curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, 0);
curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, 0);

# Give me up to 1000 search results with the Key, where
# assignee = $assignee  AND  project = $project
#  AND created < $toDate  AND  updated > $fromDate
#  AND timespent > 0
curl_setopt($curl, CURLOPT_URL, 
            "https://$server/rest/api/2/search?startIndex=0&jql=".
            "assignee+%3D+$assignee+and+project+%3D+$project+".
            "and+created+%3C+$toDate+and+updated+%3E+$fromDate+".
            "and+timespent+%3E+0&fields=key&maxResults=1000");

$issues = json_decode(curl_exec($curl), true);
foreach ($issues['issues'] as $issue) {
    $key = $issue['key'];
    # for each issue in result, give me the full worklog for that issue
    curl_setopt($curl, CURLOPT_URL,
                "https://$server/rest/api/2/issue/$key/worklog");

    $worklog = json_decode(curl_exec($curl), true);
    foreach ($worklog['worklogs'] as $entry) {
        $shortDate = substr($entry['started'], 0, 10);
        # keep a worklog entry on $key item,
        # iff within the search time period
        if ($shortDate >= $fromDate && $shortDate <= $toDate)
            $periodLog[$key][] = $entry;
    }
}
# Show Result:
#  echo json_encode($periodLog);
#  var_dump($periodLog);
?>

答案 2 :(得分:2)

值得指出的是,Jira查询有一个expand选项,允许您指定要附加到搜索中的字段:

// Javascript
$jql = 'project = MyProject and updated > 2016-02-01 and updated < 2016-03-01';

// note this definition
$fields = 'key,summary,worklog';

$query = "https://{server}/rest/api/2/search?maxResults=100&fields={fields}&jql={jql}"
  .replace(/{server}/g,$server)
  .replace(/{jql}/g,encodeURIComponent($jql))
  .replace(/{fields}/g,$fields)
  ;

返回的返回JSON对象将是一个故障单列表,每个故障单将附加一组工作项(可能为零长度)。

Javascript而不是PHP,但同样的想法仍然存在:

function getJql(params){
    $.ajax({
        url: getJiraUrl() 
            + "/rest/api/2/search?startIndex=0&fields=worklog,assignee,status,key,summary&maxResults=1000&jql=" 
            + encodeURI(params.jql),
        success: function (resp) {
            resp.issues.forEach(function(issue) {
                issue.fields.worklog.worklogs.forEach(function(work){
                    alert(JSON.stringify(work));
                    db.AddWork(work);
                });
            });
        }
    });
}

发布在GitLab上:https://gitlab.com/jefferey-cave/ProductivityBlockers/blob/5c4cb33276e8403443d4d766fc94ab2f92292da6/plugin-data-jira.js

答案 3 :(得分:0)

我个人用于同一类应用程序的方法是每周从JIRA获取所有记录,然后从存储在其中的数据库生成报告。

这样,如果发生重大JIRA崩溃,您还可以获得数据。当RAID阵列被烧毁且大部分数据无法恢复时,我们公司遇到了OnDemand实例的问题。