Comment obtenir tous les registres de travaux pour une période de temps à partir de la Jira API REST?

Je suis en train d'écrire une application avec PHP et le Tableau de l'API REST qui est nécessaire pour générer un rapport pour une période de temps avec l'accumulation d'heures consacrées par une personne sur un projet particulier.

Pour cela que j'ai besoin d'un appel qui va donner quelque chose comme cela.

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

La méthode que j'ai trouvé jusqu'à présent, était de faire la mise à jour des questions après la date de début et de filtrer les worklogs pour chaque question par la période de nouveau.

Est-il une meilleure alternative?

  • C'est une honte Jira ne prend pas en charge ces fonctions de base via l'API.
  • Je viens de réaliser que votre méthode ne fonctionnera pas et il y a en réalité semble pas de solution viable (à l'exception de la traversée de TOUTES les questions de l'histoire qui n'est pas viable). Le problème, c'est que votre solution ne fonctionne que lorsque votre TO_DATE est maintenant. Vous ne pouvez pas utiliser cette méthode pour la période dans le passé comme des questions qui ont été mis à jour après votre TO_DATE ne comptent pas, bien qu'ils pourraient avoir worklogs. Un autre problème est que Jira permet d'entrer du temps travaillé à différentes dates que MAINTENANT, requête pour filtrer les tâches de mise à jour dans la période donnée ne marchera pas.
  • au lieu de "obtenir la mise à jour des questions" , filtre par worklogDate : ajoutez à votre recherche jql : "ET worklogDate > <worklogDateFrom> + ET worklogDate < <worklogDateTo>' Puis l'ajouter à params: "&champs=worklog"
InformationsquelleAutor Himeshi | 2012-10-08
  1. 3

    Si vous ne pouvez pas trouver un out-of-the-box de la fonction qui fait ce que vous avez demandé, je pense, de trois solutions autres que la vôtre:

    1. Requête de la DB directement de sorte que vous pourraient faire le travail des journaux à l'aide d'une requête. Assurez-vous de ne pas insérer/supprimer/mettre à jour la DB directement, mais seulement à l'interroger.
    2. Utiliser quelque chose comme Jira Script Suite ou Les Comportements Plugin pour ajouter des scripts qui vont écrire le travail-logs quelque part sur le disque. Ensuite, utilisez une autre application pour lire les données à partir du disque et de l'afficher à l'utilisateur.
    3. Utiliser le Tempo plugin
    • Convient de noter qu'il n'existe aucun moyen d'une requête directement pour worklogs avec Jira de l'API. Très décevant.
    InformationsquelleAutor Kuf
  2. 3

    Comme beaucoup l'ont dit, il n'y a pas de manière directe. Toutefois, si vous restreindre l'espace de recherche de manière efficace, il n'est pas si mauvais. Le code PHP suivant s'exécute assez rapidement sur ma configuration, mais bien sûr, votre kilométrage peut varier:

    <?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);
?>
    • Eu à peu près la même idée à l'aide de MS-Hta... tu viens de m'a sauvé beaucoup de documents à lire.
    • Un problème de ce script est que certaines des questions à l'utilisateur travaillé sur peut déjà être réaffectés à d'autres utilisateurs et ainsi ils ne seront pas incluses dans le résultat.
    InformationsquelleAutor mstormo
  3. 2

    Il est intéressant de souligner que Jira requêtes ont une expand option qui vous permet de spécifier les champs que vous souhaitez attaché à votre recherche:

    //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)
  ;

    Le retour de l'objet JSON retourné sera une liste de billets, et chaque billet vous avez une collection d'éléments de travail ci-joint (potentiellement vide).

    Javascript plutôt que de PHP, mais la même idée est titulaire d':

    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);
                });
            });
        }
    });
}

    posté sur GitLab: https://gitlab.com/jefferey-cave/ProductivityBlockers/blob/5c4cb33276e8403443d4d766fc94ab2f92292da6/plugin-data-jira.js

    InformationsquelleAutor Jefferey Cave
  4. 0

    L'approche que j'ai personnellement utilisé le même type d'une application est d'obtenir TOUS les documents de JIRA sur une base hebdomadaire, puis générer des rapports à partir de la base de données, ils sont stockés.

    De cette façon, vous aurez également à disposition les données si l'un des principaux JIRA incident se produit. Notre entreprise a connu un tel problème avec un OnDemand exemple lors d'un RAID de la Matrice de brûlé et la plupart des données était irrécupérable.

    • La Confluence qui est utilisé est hébergé une. Donc, mon intérêt est d'obtenir que le worklog de données à un moment précis pour le reporting et ne pas avoir à les interroger en questions et filtre
    InformationsquelleAutor Borislav Sabev