Today is a big day. We are releasing a long requested feature: REST API for Time in Status Cloud.
Introduction
We’ve been working on this for quite a long time and now it is ready.
Time in Status 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.
To follow cloud service best practices, we employed an asynchronous export method for Time in Status 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
Time in Status Cloud REST API currently has 6 endpoints:
- POST /report/export?params={params} – Start an export
- GET /report/export/{id} – Get status or a file export
- GET /report/export – Get statuses for all exports
- GET /report/export/{id}/Download –Download file of a completed export
- DELETE /report/export/{id} –Abort an export
- GET /calendarSettings/calendar – Get calendar information
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.
For detailed information on API Keys please see the documentation page.
Please note that we are releaseing 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.
As always, feel free to reach us through plugin@obss.com.tr or pluginsupport.obss.com.tr if you have any questions.
