Documentation

FairCom REST API Reference

Next Topic

FairCom DB REST API

Reference Guide

FairCom REST API Reference

Audience:

Developers

Subject:

FairCom’s high-performance NAV and SQL database technology.

Copyright:

© Copyright 2022, FairCom Corporation. All rights reserved. For full information, see the FairCom Copyright Notice.

 This document describes the FairCom DB REST API. You will find the following sections in this document:

The REST API

REST (REpresentational State Transfer) is an architecture for distributed systems. In a REST architecture, data and functionality are considered "resources":

  • Any information can be a resource: document, image, temporal service, collection of other resources, even a "non-virtual" object, such as a person.
  • REST uses a Uniform Resource Identifier (URI) to identify the resource.
  • The state of a resource is the "resource representation": data, metadata, and hyperlinks.
  • The data format of a representation is the "media type," which defines how a representation is to be processed.
  • Resource representations are self-descriptive based on the resource's media-type.

A clearly defined set of operations is used to act upon resources. Clients and servers exchange representations of resources using a standardized interface and protocol (e.g., HTTP).

Every resource method needed to change the resource state is part of the response for that resource. Resource methods may correspond to HTTP GET, PUT, POST, and DELETE methods, although no particular assignment is required to make an API RESTful.

To be considered "RESTful," an interface must possess these properties:

  1. Client/server – The user interface is separated from the data storage.
  2. Stateless – Each client request must contain all the information necessary to understand the request (the session state is kept on the client).
  3. Cacheable – The data in a response must be labeled as cacheable or non-cacheable (if cacheable, a client can reuse that response later).
  4. Uniform interface – REST has four interface constraints: identification of resources; manipulation of resources through representations, self-descriptive messages, and hypermedia as the engine of application state.
  5. Layered system – The architecture is a hierarchy of layers. Each component cannot see beyond the immediate layer with which it is interacting.
  6. Code on demand (optional) – REST allows client functionality to be extended with applets or scripts.

FairCom DB REST API

FairCom has made FairCom DB available via a REST interface. The current offering is a Navigational API, which is ideally suited for handling raw sensor data, providing high-speed processing with immediately-consistent ACID transactions. See Navigational REST API.

References:

TOCIndex