API Overview¶
This page provides a brief, high-level overview of the CM-Well API's functionality.
For the detailed API documentation, please see the CM-Well API Reference.
Before diving into the API, we recommend reading the following introductory topics:
- Introduction to CM-Well
- Technical Aspects of CM-Well
- CM-Well Data Paradigms
- CM-Well Input and Output Formats
CM-Well is a Linked Data repository that contains information from the TR Knowledge Graph and more. It is a software platform running in TR data centers and accessible to all TR developers. It supports read, write and query operations via a REST API.
CM-Well contains RDF triples with these components: subject --> predicate --> object. For example: CompanyA --> hasImmediateParent --> CompanyB.
Since users are usually interested in a specific entity (a subject) and all of its accompanying attributes (predicates and objects), CM-Well supports a basic information unit called an infoton which contains exactly that (an entity and all of its accompanying attributes).
CM-Well API Features¶
The following table provides a high-level summary of the CM-Well API's functionality, and where to read more about each feature:
| Feature | Reference |
|---|---|
| Get infoton | Basic Queries |
| Search by field value | Advanced Queries |
| Advanced search using SPARQL | Using SPARQL on CM-Well Infotons |
| Traverse inbound/outbound links | Traversing Outbound and Inbound Links |
| Stream data | Streaming Data from CM-Well |
| Subscribe to real-time updates | Subscribing to Real-Time Updates |
| CM-Well Downloader | Using the CM-Well Downloader |
| CM-Well Ingester | Using the CM-Well Ingester |
| Create a new infoton | Updating CM-Well |
| Add/update infoton fields | Updating CM-Well |
| Delete infotons and fields | Updating CM-Well |