Introducing REST API for Time in Status Cloud

By Gizem Gokce on 06/08/24 11:09
Last updated on 6/15/26 2:00 PM

<span id="hs_cos_wrapper_name" class="hs_cos_wrapper hs_cos_wrapper_meta_field hs_cos_wrapper_type_text" style="" data-hs-cos-general-type="meta_field" data-hs-cos-type="text" >Introducing REST API for Time in Status Cloud</span>

Today is a big day. We are releasing a long requested feature: REST API for Time in Status Cloud.

We’ve been working on this for quite a long time and now it is ready. Timepiece - Time in Status for Jira Cloud REST API allows you to get Time in Status file exports via REST. You can get all types of reports (including List, Average and Sum) in all file formats (CSV, XLS, XLSX) using REST API.

To follow cloud service best practices, we employed an asynchronous export method for Timepiece Cloud. That means, you will call a REST endpoint with report parameters which will start the export. After that you will call another REST endpoint that will let you track the status and progress of the export. When completed you will call yet another endpoint to download the completed file.

Endpoints

Timepiece Cloud REST API currently has 6 endpoints:

 

Report Endpoints KEY
Single Issue GET /rest/issue
Single Issue Expanded GET /rest/issue/expanded
Issue List GET /rest/issues
Issue List v2 GET /rest/issues/v2
Issue Aggregation GET /rest/issues/aggregation
File Export POST /rest/export/status
Statuses

GET /rest/statuses

Custom Calendars

GET /rest/calendars

Parameter Sets

GET /rest/reportSettings

GET /rest/reportSettings/<param_set_id>

Format Settings API

GET /rest/formatSettings

PUT /rest/formatSettings

 

For detailed information on these endpoints please see the documentation page for REST reporting.

 

API Keys

To use the REST API, you will be directing your REST requests to Time in Status Cloud Service domain ( tis.obss.io ).

Time in Status Cloud Service uses JWT tokens for authentication and authorization of REST API. You will be adding these tokens as a query parameter to your request or including them as part of your request header.

The app introduces a new page to Jira Admin section named API Settings. Using this page you can create multiple JWT tokens, update expiry dates for existing tokens or deactivate tokens.

Please note that we are releasing the REST API as a public beta for the moment. The API is fully functional and stable but a few details might be changed in future versions based on customer feedback. Keep an eye on this blog.

To learn more and try it free for 30 days, visit Timepiece's Atlassian Marketplace page

Topics: Timepiece

No Comments Yet

Let us know what you think