In this document, Time In Status REST API and http request parameters are explained in detail.

Introduction

You can get Time in Status report data via REST. The parameters of the REST call correspond to on-screen Time in Status report parameters.

Authentication and Authorization

All REST requests shown in this document require authentication.

Authentication is handled by the Jira instance that hosts the app. Basic Authentication and OAuth can be used.

In cases where the user cannot be authenticated or authorized, one of these error responses is returned:

Expand responses...

All endpoints will return the following responses on auhtentication and authorization related errors.

Invalid Licence

HTTP 401

Encountered a "401 - Unauthorized" error while loading this page.

Unauthorized access

Go to Jira home

Invalid User

HTTP 401

When used user is not valid then JIRA server returns html page like that

Encountered a "401 - Unauthorized" error while loading this page.

Basic Authentication Failure - Reason : AUTHENTICATED_FAILED

Go to Jira home

Rest API Disabled

HTTP 503

When Rest API is disabled for the plugin, then this html is returned.

HTTP Status 503 – Service Unavailable

Type Status Report

Message Rest API is disabled

Description The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay.

Getting Issue Data

Single issue

GET /rest/tis/report/1.0/api/issue

POST /rest/tis/report/1.0/api/issue

Returns a single issue report as text (CSV or JSON)

Request

The request takes all parameters you select on the screen for a report as query parameters.

Do not let the long text scare you. Not all parameters are always required. See the params table below.

Basic:

<jira_url>/rest/tis/report/1.0/api/issue?issueKey=<issueKey>&columnsBy=<columnsBy>&calendar=<calendar>

With all parameters:

<jira_url>/rest/tis/report/1.0/api/issue?issueKey=<issueKey>&columnsBy=<columnsBy>&fields=<fields>&statuses=<statuses>&groups=<groups>&includeDeletedStatuses=<includeDeletedStatuses>&calendar=<calendar>&dayLength=<dayLength>&viewFormat=<viewFormat>&outputType=<outputType>

Parameters

Expand parameters...

Parameter	Description	Required	Value Samples
issueKey	Key of the issue that report will be generated for.	Yes	ABC-1
outputType	The output format of the report. Possible options are: CSV = Returns a CSV (comma separated value) that contains the report data as text. JSON = Returns a JSON (JavaScript Object Notation) that contains report data If not provided, "json" will be used.		csv json
columnsBy	Defines the column structure of the report. Possible options are: statusDuration = Report will show durations spent on each status as column values assigneeDuration= Report will show durations spent on each assignee as column values statusDurationByAssignee = Report will show durations spent on each status on each assignee as column values assigneeDurationByStatus = Report will show durations spent on each assignee on each status as column values groupDuration= Report will show consolidated durations spent on members of each group as column values statusCount = Report will show counts for each status transitionCount = Report will show counts for each transitions between statuses firstTransitionToStatusDate = Report will show the date the issue transitioned TO each status for the FIRST time as column values firstTransitionFromStatusDate = Report will show the date the issue transitioned FROM each status for the FIRST time as column values lastTransitionToStatusDate = Report will show the date the issue transitioned TO each status for the LAST time as column values lastTransitionFromDate = Report will show the date the issue transitioned FROM each status for the LAST time as column values	Yes	statusDuration assigneeDuration statusDurationByAssignee assigneeDurationByStatus groupDuration statusCount transitionCount firstTransitionFromStatusDate firstTransitionToStatusDate lastTransitionFromDate lastTransitionToStatusDate
fields	The IDs of fields (separated by commas) on JIRA Issues that will be added to report output as columns. Both system and custom fields are supported. For more information see TiS Server - Field Names for REST Reports		assignee,customfield_10020,customfield_10007,description,duedate, fixVersions
statuses	A JSON array listing statuses for which the durations will be included in the report. If not provided or left empty, the report will include all statuses in selected issues' histories. For assignee based reports, durations of unselected statuses will be excluded from durations of assignee columns. Supports two formats: Basic and Advanced Basic: Basic format is a comma separated list of status ID's to be included in the report. Advanced: Advanced format is a JSON text that contains status definitions. Advanced format must be employed if you want to use the Consolidated Columns feature. Type type attribute of each column defines whether the column is a Standard (std) or Consolidated (cons) column. For standard columns, id is the id of the status. For consolidated columns, the statuses array contains the IDs of statuses to be included in the column. For more information on status selection and column consolidation, please see TiS Server - Status. Other parameters may be included in the URL as a query parameter but statuses parameter is expected to be sent in request body encoded as "application/x-www-form-urlencoded"		Basic 1,3,4,5,10001,10234 Advanced [ { "id":"6", "type":"std" }, { "id":"2", "type":"std" }, { "name":"cons. status 1", "type":"cons", "statuses":[ "10008", "3", "10007" ] } ]
groups	The names of user groups (separated by commas) that will be included in Group Time report. If not provided or empty, the report will included all durations in a column named "Not a member of selected groups"		jira-administrators jira-users, jira-administrators
includeDeletedStatuses	Sets whether included statuses in issues' histories will be included in the report or not: Possible options are: true false If not provided, "true" is assumed.		true false
calendar	The calendar that report durations will be calculated based on. Possible options are: normalHour = The durations will be based on a 7/24 calendar. (default) 0 = The default business calendar n = ID of a custom calendar Tip: You can get the IDs of calendars using the Calendars endpoint, explained at the end of this page	Required for Duration reports	normalHours 0 1 2
dayLength	24HourDays = Each day will be 24 hours. businessDays = Can be used for calendars other than 7/24. The durations will be based on the business calendar defined in admin settings. Length of each day will also be based on business hours defined in admin settings.	Required for Duration reports with non-24/7 calendar	24HourDays businessDays
viewFormat	The format of duration data in the report. Possible options are: humanReadable = The values will be shown like "44 d 5 h 2 m 35 s" ddhhmmss = The values will be shown like "44:05:02:35" hhmmss = The values will be shown like "1061:02:35" days = The values will be shown in days, as a single decimal value like "44.61" hours = The values will be shown in hours, as a single decimal value like "1061.04" minutes = The values will be shown in minutes, as a single decimal value like "63662.59" seconds = The values will be shown in seconds, like "3819755" If not provided, "minutes" will be used.		humanReadable ddhhmmss hhmmss days hours minutes seconds
dateFormat	The string format to use for displaying values of fields of type Date If empty or missing, the date format defined in TiS Server - Format Settings page is used. If Format Settings date format is also empty, the default date format set for Jira is used. You can refer to the Java Documentation for more information about Date Format Strings.		yyyy-MM-dd dd/MM/yy dd/MMM/yyyy
dateTimeFormat	The string format to use for displaying values of fields of type DateTime If empty or missing, the datetime format defined in TiS Server - Format Settings page is used. If Format Settings datetime format is also empty, the default datetime format set for Jira is used. You can refer to the Java Documentation for more information about Date Format Strings.		yyyy-MM-dd hh:mm a dd/MM/yy HH:mm dd/MMM/yyyy HH:mm:ss

Examples

Expand examples...

https://192.168.0.1/rest/tis/report/1.0/api/issue?issueKey=XYZ-34&columnsBy=statusDuration&calendar=normalHours

https://192.168.0.1/rest/tis/report/1.0/api/issue?issueKey=ABC-3&columnsBy=statusDuration&fields=assignee&statuses=3,10000,10001&includeDeletedStatuses=true&calendar=normalHours&dayLength=24HourDays&viewFormat=minutes&outputType=csv

https://192.168.0.1/rest/tis/report/1.0/api/issue?issueKey=TEST-85&columnsBy=statusDuration&calendar=0&dayLength=24HourDays&viewFormat=minutes&outputType=json

https://192.168.0.1/rest/tis/report/1.0/api/issue?issueKey=TTP-123&columnsBy=statusDuration&calendar=1&dayLength=businessDays&viewFormat=minutes&outputType=csv

https://192.168.0.1/rest/tis/report/1.0/api/issue?issueKey=TIS-1&columnsBy=statusDuration&calendar=1&dayLength=businessDays&viewFormat=humanReadable

https://192.168.0.1/rest/tis/report/1.0/api/issue?issueKey=QWERTY-45&columnsBy=statusDuration&calendar=1&dayLength=businessDays&viewFormat=minutes&outputType=csv

Responses

Expand responses...

Success

HTTP 200

Returns a single issue report as text (CSV or JSON)

JSON...

{
    "dateTimeFormat": "yyyy-MM-dd hh:mm a",
    "dateFormat": "yyyy-MM-dd",
    "isComposite": false,
    "columnsBy": "Last Transition From Status Date",
    "query": "key in (sspwsd-21)",
    "reportDate": "2020-08-21 02:47 PM",
    "isAggregationType": false,
    "isOverall": false,
    "isAverage": false,
    "isSum": false,
    "table": {
        "header": {
            "headerColumns": [
                {
                    "id": "issuekey",
                    "value": "Key"
                },
                {
                    "id": "summary",
                    "value": "Summary"
                }
            ],
            "groupByColumns": [],
            "fieldColumns": [],
            "valueColumns": [
                {
                    "id": "3",
                    "value": "In Progress",
                    "isConsolidated": false
                },
                {
                    "id": "10000",
                    "value": "To Do",
                    "isConsolidated": false
                }
            ]
        },
        "body": {
            "rows": [
                {
                    "headerColumns": [
                        {
                            "id": "issuekey",
                            "value": "SSPWSD-21"
                        },
                        {
                            "id": "summary",
                            "value": "As a user, I'd like a historical story to show in reports"
                        }
                    ],
                    "groupByColumns": [],
                    "fieldColumns": [],
                    "valueColumns": [
                        {
                            "id": "3",
                            "value": "-"
                        },
                        {
                            "id": "10000",
                            "value": "2020-07-02 04:20 PM"
                        }
                    ],
                    "currentState": []
                }
            ]
        }
    }
}

CSV...

"Key","Summary","To Do","Done","In Progress"
"ABC-1","Example 1","112 d 23 h 34 m 37 s","4 s","10 s"

Invalid Parameter

HTTP 400

When one or more of the required parameters are missing or one or more of the supplied parameter values are invalid.

messages array contains the error messages for invalid parameters.

{
    "statusCode": 400,
    "messages": [
        "ERROR: Invalid outputType value: 'xls'. Possible values are 'csv' and 'json'"
    ],
    "pluginVersion": "4.9.0.1",
    "time": "2020-09-04 16:24:16"
}

Issue list

GET /rest/tis/report/1.0/api/list

POST /rest/tis/report/1.0/api/list

Returns a list report as text (CSV or JSON)

GET and POST methods provide the exact same functionality but POST method allows a much larger request size.

If your query parameters are too long to be used with a GET method (because you have a very long JQL or have too many statuses/fields selected) use POST method to access this endpoint.

Request

The request takes all parameters you select on the screen for a report as query parameters.

Do not let the long text scare you. Not all parameters are always required and some are required based on filterType. See the params table below.

Basic:

<jira_url>/rest/tis/report/1.0/api/list?filterType=<filterType>&(user=<user> | projectKey=<projectKey> | jqlFilterID=<jqlFilterID> | customjql=<customjql> | sprintID=<sprintID> )&columnsBy=<columnsBy>&calendar=<calendar>&startDate=<startDate>&endDate=<endDate>&dateRangeField=<dateRangeField>

With all parameters:

<jira_url>/rest/tis/report/1.0/api/list?filterType=<filterType>&(user=<user> | projectKey=<projectKey> | jqlFilterID=<jqlFilterID> | customjql=<customjql> | sprintID=<sprintID> )&columnsBy=<columnsBy>&fields=<fields>&statuses=<statuses>&groups=<groups>&includeDeletedStatuses=<includeDeletedStatuses>&startDate=<startDate>&endDate=<endDate>&dateRangeField=<dateRangeField>&calendar=<calendar>&dayLength=<dayLength>&viewFormat=<viewFormat>&outputType=<outputType>&groupByFields=<groupByFields>&pageSize=<pageSize>&startIssueIndex=<startIssueIndex>

Parameters

Expand parameters...

Parameter	Description	Required	Value Samples
outputType	The output format of the report. Possible options are: CSV = Returns a CSV (comma separated value) that contains the report data as text. JSON = Returns a JSON (JavaScript Object Notation) that contains report data If not provided, "json" will be used.		csv json
filterType	Defines how the issues to be included in the report will be selected. Possible options are: user = Report will filter out the issues assigned to the selected user project = Report will filter out issues in the selected Jira project jqlfilter = Report will filter out issues based on an existing JQL filter The value advanced is deprecated but is still valid and will be processed as jqlfilter. customjql = Report will filter out issues based on a given JQL query sprint = Report will filter out issues based on an existing sprint	Yes	user project jqlfilter customjql sprint
user	If filterType is user, system expects a user name in the form user=<some_user_name>	Only when filterType = user	user=admin
projectkey	If filterType is project, system expects a project key in the form projectKey=<project_key>	Only when filterType = project	projectKey=ABC
jqlfilterID	If filterType is jqlfilter, system expects a JQL filter ID in the form jqlFilterID=<jqlFilterID>	Only when filterType = jqlfilter	jqlFilterID=10145
customjql	If filterType is customjql, system expects a JQL Query in the form customjql=<customJQL>	Only when filterType = customjql	customjql=project=ABC
sprintID	If filterType is sprint, system expects a Sprint ID in the form sprintID=<sprintID>	Only when filterType = sprint	sprintID=2
columnsBy	Defines the column structure of the report. Possible options are: statusDuration = Report will show durations spent on each status as column values assigneeDuration= Report will show durations spent on each assignee as column values statusDurationByAssignee = Report will show durations spent on each status on each assignee as column values assigneeDurationByStatus = Report will show durations spent on each assignee on each status as column values groupDuration= Report will show consolidated durations spent on members of each group as column values statusCount = Report will show counts for each status transitionCount = Report will show counts for each transitions between statuses firstTransitionToStatusDate = Report will show the date the issue transitioned TO each status for the FIRST time as column values firstTransitionFromStatusDate = Report will show the date the issue transitioned FROM each status for the FIRST time as column values lastTransitionToStatusDate = Report will show the date the issue transitioned TO each status for the LAST time as column values lastTransitionFromDate = Report will show the date the issue transitioned FROM each status for the LAST time as column values	Yes	statusDuration assigneeDuration statusDurationByAssignee assigneeDurationByStatus groupDuration statusCount transitionCount firstTransitionFromStatusDate firstTransitionToStatusDate lastTransitionFromDate lastTransitionToStatusDate
pageSize	The maximum number of issues in a page. (1-200) The default is 200 and values greater than 200 or less than 0 will be processed as 200.		50
startIssueIndex	The issue index to start at. The default value is 0. The resultset is always paged as exact multiples of pageSize. startIssueIndex points to a page of resultset rather than an individual issue. The app WILL NOT return a page that contains pageSize number of issues and starts with the issue specified with startIssueIndex. The app WILL rather return the page in the resultset that contains pageSize number of issue and includes the issue specified with startIssueIndex. (You don't need to worry about this behavior if you always use startIssueIndex as a multiple of pageSize)		10
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. For more information see TiS Server - Field Names for REST Reports		assignee,customfield_10020,customfield_10007,description,duedate, fixVersions
statuses	A JSON array listing statuses for which the durations will be included in the report. If not provided or left empty, the report will include all statuses in selected issues' histories. For assignee based reports, durations of unselected statuses will be excluded from durations of assignee columns. Supports two formats: Basic and Advanced Basic: Basic format is a comma separated list of status ID's to be included in the report. Advanced: Advanced format is a JSON text that contains status definitions. Advanced format must be employed if you want to use the Consolidated Columns feature. Type type attribute of each column defines whether the column is a Standard (std) or Consolidated (cons) column. For standard columns, id is the id of the status. For consolidated columns, the statuses array contains the IDs of statuses to be included in the column. For more information on status selection and column consolidation, please see TiS Server - Status. Other parameters may be included in the URL as a query parameter but statuses parameter is expected to be sent in request body encoded as "application/x-www-form-urlencoded"		Basic 1,3,4,5,10001,10234 Advanced [ { "id":"6", "type":"std" }, { "id":"2", "type":"std" }, { "name":"cons. status 1", "type":"cons", "statuses":[ "10008", "3", "10007" ] } ]
groups	The names of user groups (separated by commas) that will be included in Group Time report. If not provided or empty, the report will included all durations in a column named "Not a member of selected groups"		jira-administrators jira-users, jira-administrators
includeDeletedStatuses	Sets whether included statuses in issues' histories will be included in the report or not: Possible options are: true false If not provided, "true" is assumed.		true false
startDate	The start date of report filter. Only issues created/resolved/updated (based on dateRangeField value) after the given date will be included in the report. Must be provided in "yyyy-MM-dd" or "yyyy-MM-dd hh:mm" format. If time parameter is not provided, default time "00:00" will be used See TiS Server - Date Range	Yes	2017-07-01 00:00
endDate	The end date of report filter. Only issues created/resolved/updated (based on dateRangeField value) before the given date will be included in the report. Must be provided in "yyyy-MM-dd" or "yyyy-MM-dd hh:mm" format. If time parameter is not provided, default time "00:00" will be used See TiS Server - Date Range	Yes	2017-08-31 23:59
dateRangeField	The system date field of the Jira issue that startDate and endDate parameters will be based on. Possible options are: created = The startDate and endDate parameters will be used to filter issues based on issue create date. updated = The startDate and endDate parameters will be used to filter issues based on issue last update date. resolved = The startDate and endDate parameters will be used to filter issues based on issue resolution date.	Yes	created updated resolved
calendar	The calendar that report durations will be calculated based on. Possible options are: normalHour = The durations will be based on a 7/24 calendar. (default) 0 = The default business calendar n = ID of a custom calendar Tip: You can get the IDs of calendars using the Calendars endpoint, explained at the end of this page	Required for Duration reports	normalHours 0 1 2
dayLength	24HourDays = Each day will be 24 hours. businessDays = Can be used for calendars other than 7/24. The durations will be based on the business calendar defined in admin settings. Length of each day will also be based on business hours defined in admin settings.	Required for Duration reports with non-24/7 calendar	24HourDays businessDays
viewFormat	The format of duration data in the report. Possible options are: humanReadable = The values will be shown like "44 d 5 h 2 m 35 s" ddhhmmss = The values will be shown like "44:05:02:35" hhmmss = The values will be shown like "1061:02:35" days = The values will be shown in days, as a single decimal value like "44.61" hours = The values will be shown in hours, as a single decimal value like "1061.04" minutes = The values will be shown in minutes, as a single decimal value like "63662.59" seconds = The values will be shown in seconds, like "3819755" milliseconds = The values will be shown in milliseconds like "5235266" If not provided, "minutes" will be used.		humanReadable ddhhmmss hhmmss days hours minutes seconds milliseconds
dateFormat	The string format to use for displaying values of fields of type Date If empty or missing, the date format defined in TiS Server - Format Settings page is used. If Format Settings date format is also empty, the default date format set for Jira is used. You can refer to the Java Documentation for more information about Date Format Strings.		yyyy-MM-dd dd/MM/yy dd/MMM/yyyy
dateTimeFormat	The string format to use for displaying values of fields of type DateTime If empty or missing, the datetime format defined in TiS Server - Format Settings page is used. If Format Settings datetime format is also empty, the default datetime format set for Jira is used. You can refer to the Java Documentation for more information about Date Format Strings.		yyyy-MM-dd hh:mm a dd/MM/yy HH:mm dd/MMM/yyyy HH:mm:ss

Examples

Expand examples...

https://192.168.0.1/rest/tis/report/1.0/api/list?filterType=user&user=admin&columnsBy=statusDuration&startDate=2017-09-01 00:00&endDate=2017-10-31 00:00&dateRangeField=created&calendar=normalHours&viewFormat=minutes&pageSize=20

https://192.168.0.1/rest/tis/report/1.0/api/list?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&dayLength=24HourDays&viewFormat=minutes&outputType=csv&groupByFields=assignee,date:year:resolutiondate,date:week:resolutiondate&startIssueIndex=75

https://192.168.0.1/rest/tis/report/1.0/api/list?filterType=project&projectKey=PMP&columnsBy=statusDuration&startDate=2017-09-01 00:00&endDate=2017-10-31 00:00 &dateRangeField=created&calendar=0&dayLength=24HourDays&viewFormat=minutes&outputType=json&groupByFields=assignee,date:year:resolutiondate,date:week:resolutiondate&pageSize=90&startIssueIndex=5

https://192.168.0.1/rest/tis/report/1.0/api/list?filterType=jqlfilter&jqlFilterID=10004&columnsBy=statusDuration&startDate=2017-09-01 00:00&endDate=2017-10-31 00:00&dateRangeField=created&calendar=1&dayLength=businessDays&viewFormat=minutes&outputType=csv

https://192.168.0.1/rest/tis/report/1.0/api/list?filterType=customjql&customjql=project=ABC&columnsBy=statusDuration&startDate=2017-09-01 00:00&endDate=2017-10-31 00:00&dateRangeField=created&calendar=1&dayLength=businessDays&viewFormat=minutes

https://192.168.0.1/rest/tis/report/1.0/api/list?filterType=sprint&sprintID=2&columnsBy=statusDuration&startDate=2017-09-01 00:00&endDate=2017-10-31 00:00&dateRangeField=created&calendar=1&dayLength=businessDays&viewFormat=minutes&outputType=json&pageSize=5

Responses

Expand responses...

Success

HTTP 200

Returns a list report as text (CSV or JSON)

JSON...

{
    "startIssueIndex": 0,
    "endIssueIndex": 4,
    "pageSize": 5,
    "total": 23,
    "dateTimeFormat": "yyyy-MM-dd hh:mm a",
    "dateFormat": "yyyy-MM-dd",
    "viewFormat": "minutes",
    "isComposite": false,
    "columnsBy": "Status Duration",
    "query": "project = SSPWSD AND created >= 1970-09-01 AND created <= 2020-12-31",
    "reportDate": "2020-08-21 03:41 PM",
    "includedStatuses": [],
    "excludedStatuses": [
        {
            "id": "10001",
            "name": "Done",
            "deleted": false
        }
    ],
    "deletedStatuses": [],
    "isAggregationType": false,
    "isOverall": false,
    "isAverage": false,
    "isSum": false,
    "table": {
        "header": {
            "headerColumns": [
                {
                    "id": "issuekey",
                    "value": "Key"
                },
                {
                    "id": "summary",
                    "value": "Summary"
                }
            ],
            "groupByColumns": [],
            "fieldColumns": [],
            "valueColumns": [
                {
                    "id": "A",
                    "value": "Consolidated Column",
                    "containsStatuses": [
                        "3"
                    ],
                    "isConsolidated": true,
                    "hint": "Contains In Progress"
                },
                {
                    "id": "3",
                    "value": "In Progress",
                    "isConsolidated": false
                },
                {
                    "id": "10000",
                    "value": "To Do",
                    "isConsolidated": false
                }
            ]
        },
        "body": {
            "rows": [
                {
                    "headerColumns": [
                        {
                            "id": "issuekey",
                            "value": "SSPWSD-23"
                        },
                        {
                            "id": "summary",
                            "value": "As a user, I'd like a historical story to show in reports"
                        }
                    ],
                    "groupByColumns": [],
                    "fieldColumns": [],
                    "valueColumns": [
                        {
                            "id": "A",
                            "value": "-"
                        },
                        {
                            "id": "3",
                            "value": "-"
                        },
                        {
                            "id": "10000",
                            "value": "4398.8132666667"
                        }
                    ],
                    "currentState": []
                },
                {
                    "headerColumns": [
                        {
                            "id": "issuekey",
                            "value": "SSPWSD-22"
                        },
                        {
                            "id": "summary",
                            "value": "As a user, I'd like a historical story to show in reports"
                        }
                    ],
                    "groupByColumns": [],
                    "fieldColumns": [],
                    "valueColumns": [
                        {
                            "id": "A",
                            "value": "-"
                        },
                        {
                            "id": "3",
                            "value": "-"
                        },
                        {
                            "id": "10000",
                            "value": "3780.0"
                        }
                    ],
                    "currentState": []
                },
                {
                    "headerColumns": [
                        {
                            "id": "issuekey",
                            "value": "SSPWSD-21"
                        },
                        {
                            "id": "summary",
                            "value": "As a user, I'd like a historical story to show in reports"
                        }
                    ],
                    "groupByColumns": [],
                    "fieldColumns": [],
                    "valueColumns": [
                        {
                            "id": "A",
                            "value": "-"
                        },
                        {
                            "id": "3",
                            "value": "-"
                        },
                        {
                            "id": "10000",
                            "value": "3200.8131666667"
                        }
                    ],
                    "currentState": []
                },
                {
                    "headerColumns": [
                        {
                            "id": "issuekey",
                            "value": "SSPWSD-20"
                        },
                        {
                            "id": "summary",
                            "value": "As a user, I'd like a historical story to show in reports"
                        }
                    ],
                    "groupByColumns": [],
                    "fieldColumns": [],
                    "valueColumns": [
                        {
                            "id": "A",
                            "value": "-"
                        },
                        {
                            "id": "3",
                            "value": "-"
                        },
                        {
                            "id": "10000",
                            "value": "1722.8131"
                        }
                    ],
                    "currentState": []
                },
                {
                    "headerColumns": [
                        {
                            "id": "issuekey",
                            "value": "SSPWSD-19"
                        },
                        {
                            "id": "summary",
                            "value": "As a user, I'd like a historical story to show in reports"
                        }
                    ],
                    "groupByColumns": [],
                    "fieldColumns": [],
                    "valueColumns": [
                        {
                            "id": "A",
                            "value": "-"
                        },
                        {
                            "id": "3",
                            "value": "-"
                        },
                        {
                            "id": "10000",
                            "value": "1080.0"
                        }
                    ],
                    "currentState": []
                }
            ]
        }
    },
    "calendar": {
        "id": "0",
        "name": "Default Calendar Settings",
        "monday": true,
        "tuesday": true,
        "wednesday": true,
        "thursday": true,
        "friday": true,
        "saturday": false,
        "sunday": false,
        "startHour": 8,
        "startMinute": 0,
        "endHour": 17,
        "endMinute": 0,
        "holidaysText": null,
        "timeZone": "Asia/Istanbul",
        "holidaysWithDesc": [],
        "holidaysWithoutDesc": [],
        "holidayMap": {},
        "default": true,
        "startTime": "08:00",
        "endTime": "17:00"
    }
}

CSV...

"Key","Summary","Consolidated Column","In Progress","To Do"
"SSPWSD-23","As a user, I'd like a historical story to show in reports","-","-","4398.8132666667"
"SSPWSD-22","As a user, I'd like a historical story to show in reports","-","-","3780.0"
"SSPWSD-21","As a user, I'd like a historical story to show in reports","-","-","3200.8131666667"
"SSPWSD-20","As a user, I'd like a historical story to show in reports","-","-","1722.8131"
"SSPWSD-19","As a user, I'd like a historical story to show in reports","-","-","1080.0"

Invalid Parameter

HTTP 400

When one or more of the required parameters are missing or one or more of the supplied parameter values are invalid.

messages array contains the error messages for invalid parameters.

{
    "statusCode": 400,
    "messages": [
        "ERROR: Invalid outputType value: 'txt'. Possible values are 'csv' and 'json'",
        "ERROR: calendar parameter is required. Possible values are normalHours or ID of a custom defined calendar"
    ],
    "pluginVersion": "4.9.0.1",
    "time": "2020-09-04 15:21:37"
}

Synchronous File Export

GET /rest/tis/report/1.0/out/file

POST /rest/tis/report/1.0/out/file

Returns Time in Status report data, in one piece, as a file export.

Sychronous means you will call a single REST endpoint (with all the required parameters) to start the export and the response of the request will return the export file.

For Asynchronous File Exports, please see here

This type of file export might return a response in a few seconds for a few issues of data but it might also take tens of minutes for 6 digit datasets.

There is no option to track export progress for Synchronous File Exports. If you need to track progress, you should use Asynchronous File Export

GET and POST methods provide the exact same functionality but POST method allows a much larger request size.

If your query parameters are too long to be used with a GET method (because you have a very long JQL or have too many statuses/fields selected) use POST method to access this endpoint.

Request

The request takes all parameters you select on the screen for a report as query parameters.

Do not let the long text scare you. Not all parameters are always required and some are required based on filterType. See the params table below.

Basic:

<jira_url>/rest/tis/report/1.0/out/file?filterType=<filterType>&(user=<user> | projectKey=<projectKey> | jqlFilterID=<jqlFilterID> | customjql=<customjql> | sprintID=<sprintID> )&columnsBy=<columnsBy>&calendar=<calendar>&outputType=<outputType>&startDate=<startDate>&endDate=<endDate>&dateRangeField=<dateRangeField>

With all parameters:

<jira_url>/rest/tis/report/1.0/out/file?filterType=<filterType>&(user=<user> | projectKey=<projectKey> | jqlFilterID=<jqlFilterID> | customjql=<customjql> | sprintID=<sprintID> )&columnsBy=<columnsBy>&fields=<fields>&statuses=<statuses>&groups=<groups>&includeDeletedStatuses=<includeDeletedStatuses>&startDate=<startDate>&endDate=<endDate>&dateRangeField=<dateRangeField>&calendar=<calendar>&dayLength=<dayLength>&viewFormat=<viewFormat>&outputType=<outputType>&groupByFields=<groupByFields>

Parameters

Expand Parameters...

Parameter	Description	Required	Value Samples
outputType	The output file format of the report. Possible options are: XLS = Returns an Excel file in XLS format that contains the list, averages and sums. XLSX = Returns an Excel file in XLSX format that contains the list, averages and sums. CSV = Returns a CSV (comma separated value) file that contains the report data. CSVAVERAGE = Returns a CSV (comma separated value) file that contains only calculated averages. CSVSUM = Returns a CSV (comma separated value) file that contains only sums of values.	Yes	xls xlsx csv csvaverage csvsum
filterType	Defines how the issues to be included in the report will be selected. Possible options are: user = Report will filter out the issues assigned to the selected user project = Report will filter out issues in the selected Jira project jqlfilter = Report will filter out issues based on an existing JQL filter The value advanced is deprecated but is still valid and will be processed as jqlfilter. customjql = Report will filter out issues based on a given JQL query sprint = Report will filter out issues based on an existing sprint	Yes	user project jqlfilter customjql sprint
user	If filterType is user, system expects a user name in the form user=<some_user_name>	Only when filterType = user	user=admin
projectkey	If filterType is project, system expects a project key in the form projectKey=<project_key>	Only when filterType = project	projectKey=ABC
jqlfilterID	If filterType is jqlfilter, system expects a JQL filter ID in the form jqlFilterID=<jqlFilterID>	Only when filterType = jqlfilter	jqlFilterID=10145
customjql	If filterType is customjql, system expects a JQL Query in the form customjql=<customJQL>	Only when filterType = customjql	customjql=project=ABC
sprintID	If filterType is sprint, system expects a Sprint ID in the form sprintID=<sprintID>	Only when filterType = sprint	sprintID=2
columnsBy	Defines the column structure of the report. Possible options are: statusDuration = Report will show durations spent on each status as column values assigneeDuration= Report will show durations spent on each assignee as column values statusDurationByAssignee = Report will show durations spent on each status on each assignee as column values assigneeDurationByStatus = Report will show durations spent on each assignee on each status as column values groupDuration= Report will show consolidated durations spent on members of each group as column values statusCount = Report will show counts for each status transitionCount = Report will show counts for each transitions between statuses firstTransitionToStatusDate = Report will show the date the issue transitioned TO each status for the FIRST time as column values firstTransitionFromStatusDate = Report will show the date the issue transitioned FROM each status for the FIRST time as column values lastTransitionToStatusDate = Report will show the date the issue transitioned TO each status for the LAST time as column values lastTransitionFromDate = Report will show the date the issue transitioned FROM each status for the LAST time as column values	Yes	statusDuration assigneeDuration statusDurationByAssignee assigneeDurationByStatus groupDuration statusCount transitionCount firstTransitionFromStatusDate firstTransitionToStatusDate lastTransitionFromDate lastTransitionToStatusDate
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. For more information see TiS Server - Field Names for REST Reports		assignee,customfield_10020,customfield_10007,description,duedate, fixVersions
groupByFields	The IDs of fields (separated by commas) on JIRA Issue that will be used to group issues for average data. Both system and custom fields are supported. Some fields are intentionally excluded. Date fields are included in a speacial format that allows data parts to be used. For further information see TiS Server - Field Names for REST Reports		assignee,customfield_10140,date:year:resolutiondate,date:week:resolutiondate
statuses	A JSON array listing statuses for which the durations will be included in the report. If not provided or left empty, the report will include all statuses in selected issues' histories. For assignee based reports, durations of unselected statuses will be excluded from durations of assignee columns. Supports two formats: Basic and Advanced Basic: Basic format is a comma separated list of status ID's to be included in the report. Advanced: Advanced format is a JSON text that contains status definitions. Advanced format must be employed if you want to use the Consolidated Columns feature. Type type attribute of each column defines whether the column is a Standard (std) or Consolidated (cons) column. For standard columns, id is the id of the status. For consolidated columns, the statuses array contains the IDs of statuses to be included in the column. For more information on status selection and column consolidation, please see TiS Server - Status. Other parameters may be included in the URL as a query parameter but statuses parameter is expected to be sent in request body encoded as "application/x-www-form-urlencoded"		Basic 1,3,4,5,10001,10234 Advanced [ { "id":"6", "type":"std" }, { "id":"2", "type":"std" }, { "name":"cons. status 1", "type":"cons", "statuses":[ "10008", "3", "10007" ] } ]
groups	The names of user groups (separated by commas) that will be included in Group Time report. If not provided or empty, the report will included all durations in a column named "Not a member of selected groups"		jira-administrators jira-users, jira-administrators
includeDeletedStatuses	Sets whether included statuses in issues' histories will be included in the report or not: Possible options are: true false If not provided, "true" is assumed.		true false
startDate	The start date of report filter. When provided, only issues created/resolved/updated (based on dateRangeField value) after the given date will be included in the report. Must be provided in "yyyy-MM-dd" or "yyyy-MM-dd hh:mm" format. If time parameter is not provided, default time "00:00" will be used See TiS Server - Date Range	Yes	2017-07-01 00:00
endDate	The end date of report filter. When provided, only issues created/resolved/updated (based on dateRangeField value) before the given date will be included in the report. Must be provided in "yyyy-MM-dd" or "yyyy-MM-dd hh:mm" format. If time parameter is not provided, default time "00:00" will be used See TiS Server - Date Range	Yes	2017-08-31 23:59`<jira_url>/rest/tis/report/1.0/api/file/<export_id>/download`
dateRangeField	The system date field of the Jira issue that startDate and endDate parameters will be based on. Possible options are: created = The startDate and endDate parameters will be used to filter issues based on issue create date. updated = The startDate and endDate parameters will be used to filter issues based on issue last update date. resolved = The startDate and endDate parameters will be used to filter issues based on issue resolution date.	Yes	created updated resolved
calendar	The calendar that report durations will be calculated based on. Possible options are: normalHour = The durations will be based on a 7/24 calendar. (default) 0 = The default business calendar n = ID of a custom calendar Tip: You can get the IDs of calendars using the Calendars endpoint, explained at the end of this page	Required for Duration reports	normalHours 0 1 2
dayLength	24HourDays = Each day will be 24 hours. businessDays = Can be used for calendars other than 7/24. The durations will be based on the business calendar defined in admin settings. Length of each day will also be based on business hours defined in admin settings.	Required for Duration reports with non-24/7 calendar	24HourDays businessDays
viewFormat	The format of duration data in the report. Possible options are: humanReadable = The values will be shown like "44 d 5 h 2 m 35 s" ddhhmmss = The values will be shown like "44:05:02:35" hhmmss = The values will be shown like "1061:02:35" days = The values will be shown in days, as a single decimal value like "44.61" hours = The values will be shown in hours, as a single decimal value like "1061.04" minutes = The values will be shown in minutes, as a single decimal value like "63662.59" seconds = The values will be shown in seconds, like "3819755" If not provided, "minutes" will be used.		humanReadable ddhhmmss hhmmss days hours minutes seconds
dateFormat	The string format to use for displaying values of fields of type Date If empty or missing, the date format defined in TiS Server - Format Settings page is used. If Format Settings date format is also empty, the default date format set for Jira is used. You can refer to the Java Documentation for more information about Date Format Strings.		yyyy-MM-dd dd/MM/yy dd/MMM/yyyy
dateTimeFormat	The string format to use for displaying values of fields of type DateTime If empty or missing, the datetime format defined in TiS Server - Format Settings page is used. If Format Settings datetime format is also empty, the default datetime format set for Jira is used. You can refer to the Java Documentation for more information about Date Format Strings.		yyyy-MM-dd hh:mm a dd/MM/yy HH:mm dd/MMM/yyyy HH:mm:ss

Examples

Expand examples...

https://192.168.0.1/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&dayLength=24HourDays&viewFormat=minutes&outputType=xls&groupByFields=assignee,date:year:resolutiondate,date:week:resolutiondate

https://192.168.0.1/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=0&dayLength=24HourDays&viewFormat=minutes&outputType=xlsx&groupByFields=assignee,date:year:resolutiondate,date:week:resolutiondate&dateFormat=yyyy-MM-dd&dateTimeFormat=yyyy-MM-dd hh:mm a

https://192.168.0.1/rest/tis/report/1.0/out/file?filterType=jqlfilter&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=1&dayLength=businessDays&viewFormat=minutes&outputType=csv&dateFormat=yy-MM-dd&dateTimeFormat=yyyy-MM-dd HH:mm:ss

https://192.168.0.1/rest/tis/report/1.0/out/file?filterType=customjql&customjql=project=ABC&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=1&dayLength=businessDays&viewFormat=minutes&outputType=csv&dateFormat=yy-MM-dd&dateTimeFormat=yyyy-MM-dd HH:mm:ss

https://192.168.0.1/rest/tis/report/1.0/out/file?filterType=sprint&sprintID=2&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=1&dayLength=businessDays&viewFormat=minutes&outputType=csv&dateFormat=yy-MM-dd&dateTimeFormat=yyyy-MM-dd HH:mm:ss

Response

The REST call returns an XLS, XLSX or CSV file that contains all the data in the report.

Asynchronous File Export

Returns Time in Status report data, in one piece, as a file export.

Asychoronous means (as a minimum) you will call a REST endpoint to start the export, call another REST endpoint to track its progress and (when completed) call yet another REST endpoint to download the file.

For Synchronous File Exports, please see here.

Start an export

POST /rest/tis/report/1.0/api/file

Starts the processing of an async file export.

Request

The request takes all parameters you select on the screen for a report as query parameters.

Do not let the long text scare you. Not all parameters are always required and some are required based on filterType. See the params table below.

Basic:

<jira_url>/rest/tis/report/1.0/api/file?filterType=<filterType>&(user=<user> | projectKey=<projectKey> | jqlFilterID=<jqlFilterID> | customjql=<customjql> | sprintID=<sprintID> )&columnsBy=<columnsBy>&calendar=<calendar>&outputType=<outputType>&startDate=<startDate>&endDate=<endDate>&dateRangeField=<dateRangeField>

With all parameters:

<jira_url>/rest/tis/report/1.0/api/file?filterType=<filterType>&(user=<user> | projectKey=<projectKey> | jqlFilterID=<jqlFilterID> | customjql=<customjql> | sprintID=<sprintID> )&columnsBy=<columnsBy>&fields=<fields>&statuses=<statuses>&groups=<groups>&includeDeletedStatuses=<includeDeletedStatuses>&startDate=<startDate>&endDate=<endDate>&dateRangeField=<dateRangeField>&calendar=<calendar>&dayLength=<dayLength>&viewFormat=<viewFormat>&outputType=<outputType>&groupByFields=<groupByFields>

Parameters

Expand Parameters...

Parameter	Description	Required	Value Samples
outputType	The output file format of the report. Possible options are: XLS = Returns an Excel file in XLS format that contains the list, averages and sums. XLSX = Returns an Excel file in XLSX format that contains the list, averages and sums. CSV = Returns a CSV (comma separated value) file that contains the report data. CSVAVERAGE = Returns a CSV (comma separated value) file that contains only calculated averages. CSVSUM = Returns a CSV (comma separated value) file that contains only sums of values.	Yes	xls xlsx csv csvaverage csvsum
filterType	Defines how the issues to be included in the report will be selected. Possible options are: user = Report will filter out the issues assigned to the selected user project = Report will filter out issues in the selected Jira project jqlfilter = Report will filter out issues based on an existing JQL filter The value advanced is deprecated but is still valid and will be processed as jqlfilter. customjql = Report will filter out issues based on a given JQL query sprint = Report will filter out issues based on an existing sprint	Yes	user project jqlfilter customjql sprint
user	If filterType is user, system expects a user name in the form user=<some_user_name>	Only when filterType = user	user=admin
projectkey	If filterType is project, system expects a project key in the form projectKey=<project_key>	Only when filterType = project	projectKey=ABC
jqlfilterID	If filterType is jqlfilter, system expects a JQL filter ID in the form jqlFilterID=<jqlFilterID>	Only when filterType = jqlfilter	jqlFilterID=10145
customjql	If filterType is customjql, system expects a JQL Query in the form customjql=<customJQL>	Only when filterType = customjql	customjql=project=ABC
sprintID	If filterType is sprint, system expects a Sprint ID in the form sprintID=<sprintID>	Only when filterType = sprint	sprintID=2
columnsBy	Defines the column structure of the report. Possible options are: statusDuration = Report will show durations spent on each status as column values assigneeDuration= Report will show durations spent on each assignee as column values statusDurationByAssignee = Report will show durations spent on each status on each assignee as column values assigneeDurationByStatus = Report will show durations spent on each assignee on each status as column values groupDuration= Report will show consolidated durations spent on members of each group as column values statusCount = Report will show counts for each status transitionCount = Report will show counts for each transitions between statuses firstTransitionToStatusDate = Report will show the date the issue transitioned TO each status for the FIRST time as column values firstTransitionFromStatusDate = Report will show the date the issue transitioned FROM each status for the FIRST time as column values lastTransitionToStatusDate = Report will show the date the issue transitioned TO each status for the LAST time as column values lastTransitionFromDate = Report will show the date the issue transitioned FROM each status for the LAST time as column values	Yes	statusDuration assigneeDuration statusDurationByAssignee assigneeDurationByStatus groupDuration statusCount transitionCount firstTransitionFromStatusDate firstTransitionToStatusDate lastTransitionFromDate lastTransitionToStatusDate
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. For more information see TiS Server - Field Names for REST Reports		assignee,customfield_10020,customfield_10007,description,duedate, fixVersions
groupByFields	The IDs of fields (separated by commas) on JIRA Issue that will be used to group issues for average data. Both system and custom fields are supported. Some fields are intentionally excluded. Date fields are included in a speacial format that allows data parts to be used. For further information see TiS Server - Field Names for REST Reports		assignee,customfield_10140,date:year:resolutiondate,date:week:resolutiondate
statuses	A JSON array listing statuses for which the durations will be included in the report. If not provided or left empty, the report will include all statuses in selected issues' histories. For assignee based reports, durations of unselected statuses will be excluded from durations of assignee columns. Supports two formats: Basic and Advanced Basic: Basic format is a comma separated list of status ID's to be included in the report. Advanced: Advanced format is a JSON text that contains status definitions. Advanced format must be employed if you want to use the Consolidated Columns feature. Type type attribute of each column defines whether the column is a Standard (std) or Consolidated (cons) column. For standard columns, id is the id of the status. For consolidated columns, the statuses array contains the IDs of statuses to be included in the column. For more information on status selection and column consolidation, please see TiS Server - Status. Other parameters may be included in the URL as a query parameter but statuses parameter is expected to be sent in request body encoded as "application/x-www-form-urlencoded"		Basic 1,3,4,5,10001,10234 Advanced [ { "id":"6", "type":"std" }, { "id":"2", "type":"std" }, { "name":"cons. status 1", "type":"cons", "statuses":[ "10008", "3", "10007" ] } ]
groups	The names of user groups (separated by commas) that will be included in Group Time report. If not provided or empty, the report will included all durations in a column named "Not a member of selected groups"		jira-administrators jira-users, jira-administrators
includeDeletedStatuses	Sets whether included statuses in issues' histories will be included in the report or not: Possible options are: true false If not provided, "true" is assumed.		true false
startDate	The start date of report filter. Only issues created/resolved/updated (based on dateRangeField value) after the given date will be included in the report. Must be provided in "yyyy-MM-dd" or "yyyy-MM-dd hh:mm" format. If time parameter is not provided, default time "00:00" will be used See TiS Server - Date Range	Yes	2017-07-01 00:00
endDate	The end date of report filter. Only issues created/resolved/updated (based on dateRangeField value) before the given date will be included in the report. Must be provided in "yyyy-MM-dd" or "yyyy-MM-dd hh:mm" format. If time parameter is not provided, default time "00:00" will be used See TiS Server - Date Range	Yes	2017-08-31 23:59
dateRangeField	The system date field of the Jira issue that startDate and endDate parameters will be based on. Possible options are: created = The startDate and endDate parameters will be used to filter issues based on issue create date. updated = The startDate and endDate parameters will be used to filter issues based on issue last update date. resolved = The startDate and endDate parameters will be used to filter issues based on issue resolution date.	Yes	created updated resolved
calendar	The calendar that report durations will be calculated based on. Possible options are: normalHour = The durations will be based on a 7/24 calendar. (default) 0 = The default business calendar n = ID of a custom calendar Tip: You can get the IDs of calendars using the Calendars endpoint, explained at the end of this page	Required for Duration reports	normalHours 0 1 2
dayLength	24HourDays = Each day will be 24 hours. businessDays = Can be used for calendars other than 7/24. The durations will be based on the business calendar defined in admin settings. Length of each day will also be based on business hours defined in admin settings.	Required for Duration reports	24HourDays businessDays
viewFormat	The format of duration data in the report. Possible options are: humanReadable = The values will be shown like "44 d 5 h 2 m 35 s" ddhhmmss = The values will be shown like "44:05:02:35" hhmmss = The values will be shown like "1061:02:35" days = The values will be shown in days, as a single decimal value like "44.61" hours = The values will be shown in hours, as a single decimal value like "1061.04" minutes = The values will be shown in minutes, as a single decimal value like "63662.59" seconds = The values will be shown in seconds, like "3819755" If not provided, "minutes" will be used.		humanReadable ddhhmmss hhmmss days hours minutes seconds
dateFormat	The string format to use for displaying values of fields of type Date If empty or missing, the date format defined in TiS Server - Format Settings page is used. If Format Settings date format is also empty, the default date format set for Jira is used. You can refer to the Java Documentation for more information about Date Format Strings.		yyyy-MM-dd dd/MM/yy dd/MMM/yyyy
dateTimeFormat	The string format to use for displaying values of fields of type DateTime If empty or missing, the datetime format defined in TiS Server - Format Settings page is used. If Format Settings datetime format is also empty, the default datetime format set for Jira is used. You can refer to the Java Documentation for more information about Date Format Strings.		yyyy-MM-dd hh:mm a dd/MM/yy HH:mm dd/MMM/yyyy HH:mm:ss

Examples

Expand examples...

https://192.168.0.1/rest/tis/report/1.0/api/file?filterType=user&user=admin&columnsBy=statusDuration&startDate=2017-09-01 00:00&endDate=2017-10-31 00:00&dateRangeField=created&calendar=normalHours&viewFormat=minutes&outputType=xls

https://192.168.0.1/rest/tis/report/1.0/api/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&dayLength=24HourDays&viewFormat=minutes&outputType=xls&groupByFields=assignee,date:year:resolutiondate,date:week:resolutiondate

https://192.168.0.1/rest/tis/report/1.0/api/file?filterType=project&projectKey=PMP&columnsBy=statusDuration&startDate=2017-09-01 00:00&endDate=2017-10-31 00:00 &dateRangeField=created&calendar=0&dayLength=24HourDays&viewFormat=minutes&outputType=xlsx&groupByFields=assignee,date:year:resolutiondate,date:week:resolutiondate

https://192.168.0.1/rest/tis/report/1.0/api/file?filterType=jqlfilter&jqlFilterID=10004&columnsBy=statusDuration&startDate=2017-09-01 00:00&endDate=2017-10-31 00:00&dateRangeField=created&calendar=1&dayLength=businessDays&viewFormat=minutes&outputType=csv

https://192.168.0.1/rest/tis/report/1.0/api/file?filterType=customjql&customjql=project=ABC&columnsBy=statusDuration&startDate=2017-09-01 00:00&endDate=2017-10-31 00:00&dateRangeField=created&calendar=1&dayLength=businessDays&viewFormat=minutes&outputType=csv

https://192.168.0.1/rest/tis/report/1.0/api/file?filterType=sprint&sprintID=2&columnsBy=statusDuration&startDate=2017-09-01 00:00&endDate=2017-10-31 00:00&dateRangeField=created&calendar=1&dayLength=businessDays&viewFormat=minutes&outputType=csv

Responses

Expand responses...

Success

HTTP 200

When the parameters are validated and the export process has successfully started on the system.

{
    "exportId": "6ac3af4e-1d2b-4886-8455-23932fc2620c",
    "statusLink": "https://192.168.0.1/rest/tis/report/1.0/api/file/6ac3af4e-1d2b-4886-8455-23932fc2620c"
}

Invalid Parameter

HTTP 400

When one or more of the required parameters are missing or one or more of the supplied parameter values are invalid.

messages array contains the error messages for invalid parameters.

{
    "statusCode": 400,
    "messages": [
        "ERROR: calendar parameter is required. Possible values are normalHours or ID of a custom defined calendar",
        "ERROR: endDate parameter is required. Expected format is yyyy-MM-dd hh:mm<br>"
    ],
    "pluginVersion": "4.9.0.1",
    "time": "2020-09-04 16:41:29"
}

Export Limit Exceeded

HTTP 429

When you start too many simultaneous file exports and exceed the concurrent export limit per user.

You should either wait for some fo the file exports to complete or cancel some of the running file exports.

{
    "status": 429,
    "messages": [
        "ERROR: You've reached your concurrent export limit. Wait for running file exports to complete or cancel some of the running file exports."
    ],
    "pluginVersion": "4.9.0.1",
    "time": "2020-09-04 16:52:29"
}

Get status of all exports

GET /rest/tis/report/1.0/api/file

A detailed list of async file exports in the system.

Supports paging

Request

<jira_url>/rest/tis/report/1.0/api/file

Parameters

Expand parameters...

Parameter

Description

Required

pageNumber

The page index to start at, when paging is employed.

Works with zero-based index so pageNumber for the first page is 0.

The default value is 0.

No

pageSize

The maximum number of items in a page.

The default is 100 and values greater than 100 will be processed as 100

No

Examples

Expand examples...

https://192.168.0.1/rest/tis/report/1.0/api/file

https://192.168.0.1/rest/tis/report/1.0/api/file?pageNumber=10&pageSize=5

Responses

Expand responses...

Success

HTTP 200

Returns a JSON that contains all file exports of your instance, running or completed.

{
    "pageNumber": 2,
    "pageSize": 5,
    "totalExportCount": 24,
    "last": false,
    "exports": [
        {
            "exportId": "6a5c3529-af63-44e1-a17c-d3546b135db0",
            "created": "24/Aug/20 5:21 PM",
            "completed": 23,
            "total": 23,
            "downloadLink": "https://192.168.0.1/rest/tis/report/1.0/api/file/download",
            "status": "Successful"
        },
        {
            "exportId": "abdcd876-b45e-4815-8f01-cdf20fd1fd0a",
            "created": "24/Aug/20 5:14 PM",
            "completed": 23,
            "total": 23,
            "downloadLink": "https://192.168.0.1/rest/tis/report/1.0/api/file/download",
            "status": "Successful"
        },
        {
            "exportId": "09db197c-54d7-4409-a7d8-31be0f927dc4",
            "created": "24/Aug/20 5:11 PM",
            "completed": 23,
            "total": 23,
            "downloadLink": "https://192.168.0.1/rest/tis/report/1.0/api/file/download",
            "status": "Successful"
        },
        {
            "exportId": "2e602b9a-9183-4042-84de-1a06ccb7d43d",
            "created": "24/Aug/20 4:56 PM",
            "message": "Report is aborted by user",
            "status": "Aborted By User"
        },
        {
            "exportId": "7916057a-c22c-4ea1-a371-2c72059472b2",
            "created": "24/Aug/20 4:45 PM",
            "completed": 23,
            "total": 23,
            "downloadLink": "https://192.168.0.1/rest/tis/report/1.0/api/file/download",
            "status": "Successful"
        }
    ]
}

Invalid Paging Parameters

HTTP 400

When at least one of the providedg pagin parameters contain an invalid value.

{
    "status": 400,
    "message": "Invalid paging parameters.",
    "messages": [
        "For input string: \"two\""
    ],
    "pluginVersion": "4.9.0.1",
    "time": "2020-09-04 16:17:23"
}

Get status of a single export

GET /rest/tis/report/1.0/api/file/<export_id>

Details of a single async file export in the system.

Request

<jira_url>/rest/tis/report/1.0/api/file/<export_id>

Parameters

Expand Parameters...

Parameter	Description	Required	Value Samples
export_id	The id of the file export that you want to query the information for	Yes	d57e59ca-568a-43a0-8baa-2b86a404d1fc

Example

Expand Examples...

https://192.168.0.1/rest/tis/report/1.0/api/file/d57e59ca-568a-43a0-8baa-2b86a404d1fc

Responses

Expand responses...

Success

HTTP 200

Returns a JSON that contains detailed information of a file export.

{
    "exportId": "c960b836-516b-45ac-b707-170114bdef74",
    "created": "24/Aug/20 5:23 PM",
    "completed": 23,
    "total": 23,
    "downloadLink": "https://192.168.0.1/rest/tis/report/1.0/api/file/c960b836-516b-45ac-b707-170114bdef74/download",
    "status": "Successful"
}

Export Not Found

HTTP 404

When an export with the given export_id is not found. The export_id might be invalid or the export might belong to another user

{
    "message": "The export with id 29c33054-64b3-44e5-8e01-2c71a7e4s could not be found or you do not have permission to view it.",
    "statusCode": 404,
    "pluginVersion": "4.9.0.1",
    "time": "2020-09-04 16:21:28"
}

Download export file

GET /rest/tis/report/1.0/api/file/<export_id>/download

Downloads the file for a completed async file export operation.

Request

<jira_url>/rest/tis/report/1.0/api/file/<export_id>/download

Parameters

Expand parameters...

Parameter	Description	Required	Value Samples
export_id	The id of the file export that you want to query the information for	Yes	341abae0-e277-4302-a6f9-cd7b5643ddef

Examples

Expand examples...

https://192.168.0.1/rest/tis/report/1.0/api/file/341abae0-e277-4302-a6f9-cd7b5643ddef/download

Responses

Expand responses...

Success

HTTP 200

Returns a file that contains the generated export data.

Export Not Found

HTTP 404

When an export with the given export_id is not found. The export_id might be invalid or the export might belong to another user.

{
    "message": "The export with id 341abae0-e277-4302-a6f9-cd7b5643ddef could not be found or you do not have permission to view it.",
    "statusCode": 404,
    "pluginVersion": "4.9.0.1",
    "time": "2020-09-04 16:38:57"
}

Export Not Completed

HTTP 404

When the export is in a state other than Successful. The export might still be in progress, might be aborted or might have failed.

{
    "message": "The report with id d6db17d3-40b6-4afd-a1f5-4b7639c4a08c is not completed. It is still being processed.",
    "statusCode": 404,
    "pluginVersion": "4.9.0.1",
    "time": "2020-09-04 16:49:05"
}

Export Failed

HTTP 404

When the export is in a state other than Successful. The export might still be aborted or might have failed.

{
    "message": "The report with id d6db17d3-40b6-4afd-a1f5-4b7639c4a08c failed or is aborted.",
    "statusCode": 404,
    "messages": [
        "Report is aborted by user"
    ],
    "pluginVersion": "4.9.0.1",
    "time": "2020-09-04 16:51:54"
}

Abort an export

DELETE /rest/tis/report/1.0/api/file/<export_id>

Abort a running async file export.

Request

<jira_url>/rest/tis/report/1.0/api/file/<export_id>

Parameters

Expand parameters...

Parameter	Description	Required	Value Samples
export_id	The id of the file export that you want to query the information for	Yes	341abae0-e277-4302-a6f9-cd7b5643ddef

Examples

Expand examples...

https://192.168.0.1/rest/tis/report/1.0/api/file/341abae0-e277-4302-a6f9-cd7b5643ddef

Responses

Expand responses...

Success

HTTP 200

Returns a JSON that contains information about the aborted export.

{
    "exportId": "b841b270-77b6-41d8-9d4f-25c48211a49c",
    "created": "24/Aug/20 5:35 PM",
    "completed": 1,
    "total": 23,
    "status": "Aborted By User"
}

Export Not Found

HTTP 404

When an export with the given export_id is not found. The export_id might be invalid or the export might belong to another user.

{
    "message": "The export with id 3c2099ce-3874-4812-ad95-e8fecfdff821 could not be found or you do not have permission to view it.",
    "statusCode": 404,
    "pluginVersion": "4.9.0.1",
    "time": "2020-09-04 16:52:32"
}

Export Already Completed

HTTP 404

The file export was not aborted because the export was completed before the abort command was received by the process.

{
    "message": "Could not abort since the report has already completed",
    "statusCode": 404,
    "pluginVersion": "4.9.0.1",
    "time": "2020-09-04 16:32:54"
}

Calendars

GET <jira_url>/rest/tis/report/1.0/data/calendars

A list of calendars defined in the system with their IDs can be requsted through the following REST endpoint.

Request

<service_url>/rest/tis/report/1.0/data/calendars

Parameters

This request requires no parameters.

Examples

Expand examples...

https://192.168.0.1/rest/tis/report/1.0/data/calendars

Responses

Expand responses...

Success

HTTP 200

Returns a JSON that contains all calendars defined in your instance, including the predefined 7/24 (normalHours) Calendar and Default Calendar Settings.

{
    "calendars": [
        {
            "id": "normalHours",
            "name": "7/24",
            "monday": true,
            "tuesday": true,
            "wednesday": true,
            "thursday": true,
            "friday": true,
            "saturday": true,
            "sunday": true,
            "workHours": "00:00 - 00:00",
            "holidays": [],
            "timeZone": "Asia/Istanbul"
        },
        {
            "id": "0",
            "name": "Default Calendar Settings",
            "monday": true,
            "tuesday": true,
            "wednesday": true,
            "thursday": true,
            "friday": true,
            "saturday": false,
            "sunday": false,
            "workHours": "08:00 - 17:00",
            "holidays": [],
            "timeZone": "Asia/Istanbul"
        },
        {
            "id": "2",
            "name": "calendar_rc",
            "monday": false,
            "tuesday": false,
            "wednesday": true,
            "thursday": true,
            "friday": true,
            "saturday": false,
            "sunday": false,
            "workHours": "08:00 - 17:00",
            "holidays": [],
            "timeZone": "Asia/Istanbul"
        },
        {
            "id": "1",
            "name": "kalender rc",
            "monday": true,
            "tuesday": true,
            "wednesday": true,
            "thursday": true,
            "friday": true,
            "saturday": false,
            "sunday": false,
            "workHours": "08:00 - 17:00",
            "holidays": [],
            "timeZone": "Asia/Istanbul"
        }
    ]
}

Page tree

TiS v4.9 - REST Reporting

Authentication and Authorization

Invalid Licence

Invalid User

Rest API Disabled

Getting Issue Data

Single issue

Request

Parameters

Examples

Responses

Success

Invalid Parameter

Issue list

Request

Parameters

Examples

Responses

Success

Invalid Parameter

Synchronous File Export

Request

Parameters

Examples

Response

Asynchronous File Export

Start an export

Request

Parameters

Examples

Responses

Success

Invalid Parameter

Export Limit Exceeded

Get status of all exports

Request

Parameters

Examples

Responses

Invalid Paging Parameters

Get status of a single export

Request

Responses

Download export file

Request

Parameters

Examples

Responses

Success

Export Not Found

Export Not Completed

Export Failed

Abort an export

Request

Parameters

Examples

Responses

Success

Export Not Found

Export Already Completed

Calendars

Request

Parameters

Examples

Success