Solved

CDF Templates API documentation and itroduction

  • 10 October 2021
  • 3 replies
  • 123 views

Userlevel 4
Badge

Hi there,

I am looking for resources on CDF templates API.

So far I the best introduction I have found is the Python SDK documentation, as well as the information at docs.cognite.com which focuses on using templates in fusion.

Can you provide more information about how to use the templates API?

icon

Best answer by Jørgen Tennøe 11 October 2021, 21:53

View original

3 replies

Badge

I’m not sure what you specifically look for, but if you are looking of API info, it’s here

https://docs.cognite.com/api/playground/#tag/Template-completion

Userlevel 4
Badge

These API docs are for the template completion API.

I am looking for more documentation on the Templates-API, the one used by the Python-SDK linked above.

Particularly, I would like to learn more about intended use-cases and what kind of volumes it supports.

Hi and thank you for your interest in templates API! 

The main use case for templates is to allow applications and solutions to express their data model as a semantic layer on top of data in Cognite Data Fusion. Often solutions use different concepts than what exists in the source data directly. An example would be a solution for pumps, where the relevant sensors are addressable as properties of the pump objects in the application’s data model created with the templates API. The solution can then query pump data, with properties and belonging data points through a single graphql query. 

The templates API is a preview capability, we are eagerly taking feedback and are curious on how we can improve it. Sending you a PM in case you are interested in a follow up.

The documentation, both on the API capabilities and on the guides are, as you have experienced, incomplete. 

 

Best regards,

Jørgen Tennøe

Reply