Power of Standards: Why OData Shines in Time Cockpit

Tuesday, June 3, 2014 by Rainer Stropek

For time cockpit's web API, we have decided to go for OData instead of building a custom REST-based API. This decision wasn't easy. Fulfilling the OData standard does not come for free. It took us quite some time to create a custom OData endpoint that reflects the level of extensibility that time cockpit is known for. We couldn't use the default implementations of Microsoft's ASP.NET at all.

Why OData?

So why did we take the extra miles to support OData? Simply because it is a much richer standard. Months ago when we made the decision for OData, we hoped that over time more and more tools would appear that understand OData. They would be able to speak with time cockpit immediately because of the standard.

OData is Gathering Speed

OData has become an OASIS standard, practically all new Microsoft web APIs are OData, SAP is heavily using OData - OData is becoming more and more important. Therefore you see a raising number of OData tools appear on the market. One of them is XOData from the UK company PragmatiQa. Let's take a look at this product and connect it with time cockpit.

XOData

XOData is a generic OData client that includes various visualizers for the data model as well as a query builder. It is no end user tool. However, if you are a power user or a developer, you will probably find XOData very handy.

Recently, PragmatiQa has released XOData as a Chrome App (link to Chrome Web Store where you can get it). There is a free trial version that you can use for your first experiments. Once you installed it, XOData is available in your Chrome App Launcher:

Connect XOData With Time Cockpit

Connecting XOData with time cockpit is super simple. It requires two easy steps:

  1. Open the Connection tab and enter your time cockpit user and password.
  2. Enter the time cockpit OData URI in XOData:
    1. Select OData Metadata URL as your access option
    2. Enter URL or time cockpit's OData endpoint: https://apipreview.timecockpit.com/odata/$metadata

Your are Ready to Go!

Now you can start using XOData with time cockpit. Click on Get Details to see your time cockpit data model in XOData (click on image to enlarge):


Query Builder

Use the Query Builder tab to create a query. Developers can get the raw OData feed (click on image to enlarge):


XOData also supports executing the query. You can browse the result in a tabular form or even export it to the Excel-compatible CSV format (click on image to enlarge):


Time Cockpit OData is Preview

Please keep in mind that time cockpit's OData web api is still in preview phase. If you experience any problems with it, we would love to hear your feedback and support you at support@timecockpit.com.

comments powered by Disqus