New Feature: Using Parameter Sets for Timepiece REST API Reports


With this week’s release of Timepiece (formerly Time in Status) for Jira Cloud, we are introducing the ability to use Parameter Sets while getting REST API reports.

Until this release, while using Timepiece REST API for integrations, you had to explicitly provide all report parameters to get a report. This was a little cumbersome. Customers frequently requested the option to reference a parameter set, instead of giving all parameters every time. After all, a parameter set already contains all the needed parameters. With this release, Timepiece now supports referencing parameter sets for REST API reports.

How does it work?

You can reference a parameter set simply by providing the parameter set ID as the “paramSetId” parameter.

When a parameter set is referenced, all the report parameters are taken from that parameter set. (Some REST endpoints might require additional parameters but the API response will warn you about that).

We took this one step further. You can both reference a parameter set for your report and explicitly provide some of the parameters. In that case, the explicitly provided parameters will override the parameters in the parameter set, others will be used from the parameter set.

How will this help me?

This new feature makes some exciting use cases possible.

First of all, building integrations becomes easier since all you need to do is provide a tisjwt and a parameter set ID.

Second, you can change the behavior of your integration by simply changing the parameters saved in the parameter set. The integration code will start acting according to the new definition.

And third, you can use a single parameter set for multiple report integrations, by simply overriding some of the parameters. For example, you can use the same parameter to get a Status Duration report and an Assignee Durations report, by simply overriding the reportType parameter in each REST call.

Where to start?

Almost all REST API endpoints support this new option. Please see this documentation page for details about how to use it.

This new feature is currently available only for Timepiece (formerly Time in Status) Jira Cloud and only for REST API reports. Jira DC support is in the works. We are also planning to make this possible on Timepiece dashboard gadgets.

If you have further questions, you can reach the OBSS support team through appsupport.obss.com.tr or by sending an e-mail to appsupport@obss.tech

Emre Toptancı