REST API
It is possible to access report data via REST call to a JIRA endpoint introduced by Time in Status. The parameters of the REST call correspond to Time in Status report parameters explained above.
Rest Call Format
The rest call should be made in the following format
<base_url>/rest/tis/report/1.0/<format>?filterType=<filterType>&<user|projectKey|jqlFilterID>=<selection>&columnsBy=<columnsBy>&fields=<fields>&statuses=<statuses>&includeDeletedStatuses=<includeDeletedStatuses>&startDate=<startDate>&endDate=endDate&dateRangeField=<dateRangeField>&calendar=<calendar>&viewFormat=<viewFormat>&outputType=<outputType>
Parameters
Token | Description | Required | Value Samples |
---|---|---|---|
base_url | The baseURL of your JIRA instance. | Yes |
|
outputType | The output file format of the report. Possible options are:
| Yes |
|
filterType | Defines how the issues to be included in the report will be selected. Possible options are:
| Yes |
|
selection | Defines the value that will be used to filter the issues. This parameter depends on reportType selection.
| Yes |
|
columnsBy | Defines the column structure of the report. Possible options are:
| Yes |
|
fields | The IDs of fields (separated by commas) on JIRA Issue that will be added to report output as columns. Both system and custom fields are supported. | assignee,customfield_10020,customfield_10007,description,duedate, fixVersions | |
statuses | The IDs of statuses of which the durations will be included in the report. System expects you to provide existing status IDs. It is possible to leave this parameter empty but then the report will include issue rows without any duration columns. For assignee based reports, durations of unselected statuses will be excluded from durations of assignee columns. If not provided, the report will include all statuses in issues' histories. |
| |
includeDeletedStatuses | Sets whether included statuses in issues' histories will be included in the report or not: Possible options are:
In not provided, "true" is assumed. |
| |
startDate | The start date of report interval in "yyyy-MM-dd" or "yyyy-MM-dd hh:mm" format. If time parameter is no given default time "00:00" will be process | Yes | 2017-07-01 00:00 |
endDate | The end date of report interval in "yyyy-MM-dd" or "yyyy-MM-dd hh:mm" format. If time parameter is no given default time "00:00" will be process | Yes | 2017-08-31 23:59 |
dateConditionField | The dateConditionField type that startDate and endDate parameters will be based on. Possible options are:
| Yes |
|
calendar | The calendar that report durations will be calculated based on. Possible options are:
| Yes |
|
viewFormat | The format of duration data in the report. Possible options are:
| Yes |
|
Examples:
http://192.168.0.71:7500/jira75/rest/tis/report/1.0/out/file?filterType=user&user=admin&columnsBy=statusDuration&fields=assignee&statuses=3,10000,10001&includeDeletedStatuses=true&startDate=2017-09-01 00:00&endDate=2017-10-31 00:00&dateRangeField=created&calendar=normalHours&viewFormat=minutes&outputType=xls
http://192.168.0.71:7500/jira75/rest/tis/report/1.0/out/file?filterType=project&projectKey=PMP&columnsBy=statusDuration&fields=assignee&statuses=3,10000,10001&includeDeletedStatuses=true&startDate=2017-09-01 00:00&endDate=2017-10-31 00:00&dateRangeField=created&calendar=normalHours&viewFormat=minutes&outputType=xlsx
http://192.168.0.71:7500/jira75/rest/tis/report/1.0/out/file?filterType=advanced&jqlFilterID=10004&columnsBy=statusDuration&fields=assignee&statuses=3,10000,10001&includeDeletedStatuses=true&startDate=2017-09-01 00:00&endDate=2017-10-31 00:00&dateRangeField=created&calendar=normalHours&viewFormat=minutes&outputType=csv
Return
The REST call returns an XLS, XLSX or CSV file that contains all the data in the report.