Web API

Time cockpit offers a web-based API. HTTP, REST and JSON can be used to access and modify information, execute business logic or generating a report without depending on our .NET SDK. This service is publicly hosted and customers do not have to perform any additional installation or configuration steps.

The time cockpit API provides various endpoints:

• OData Endpoint: Supports filtered queries, metadata reflection, and data manipulation (i.e. insert, update, delete)
• Query Endpoint: Supports querying time cockpit data using the time cockpit query language (TCQL).
• ExecuteList Endpoint: Execute time cockpit lists. Lists are used to display data in a tabular form in the UI, but their data can also be fetched using the Web API.
• ExecuteAction Endpoint: Execute time cockpit actions. An action is custom business logic that is hosted in your time cockpit tenant.
• Reporting Endpoint: Execute a time cockpit SSRS report.

Base Address

The base address of our web API is https://api.timecockpit.com. It is only accessible via HTTPS and you need to authenticate before you can use the API.

Authentication

Three forms of authentication are currently supported:

• Token authentication offers a simple and efficient way to authenticate web requests. A header is used to transfer the access token and identify the bearer.
• Basic authentication with username and password is used by tools that do not offer token authentication (e.g. OData in Excel) and to initially acquire authentication tokens.
• PAT authentication.

Warning

We strongly discourage to use token or basic authentication. These methods of authentication will be disabled in the foreseeable future. We strongly recommend authenticating using PATs.

To learn how to authenticate against our Web API refer to authentication.