Applies to: Kyvos Enterprise  Kyvos Cloud (SaaS on AWS) Kyvos AWS Marketplace

Kyvos Azure Marketplace   Kyvos GCP Marketplace Kyvos Single Node Installation (Kyvos SNI)

REST integration architecture 

The following figure illustrates REST integration architecture. 

Open

The architecture consists of the following components. 

• Host Application: Any application capable of sending REST requests to the Kyvos application. 

• Kyvos Cluster: One or more computers on which Kyvos software is running. Generally, this cluster is deployed on Hadoop cluster computers. One of these computers deploys the Kyvos web application, which acts as a communication point for the REST APIs. You may need the web application URL to use the APIs. 

• APIs: The APIs provide REST services to list, create, update, and delete semantic models and other repository items. This also invokes Kyvos actions, such as starting a semantic model process. Responses are given in the form of XMLs. 

REST APIs 

In the case of Java-based REST client (host application), to parse the XML and populate Java beans, include the following jar files in the classpath of the host application. 

• json-simple-1.1.1.jar 

• kyvosclient.jar 

• kyvoscommons.jar 

• log4j-1.2.14.jar 

• xercesImpl-2.9.1.jar 

• xmlParserAPIs-2.6.2.jar 

The Kyvos installer contains these files at the <Kyvos_Web_App_path>\WEB-INF\lib location. 

Response code 

The Kyvos API attempts to return appropriate status codes for every request. 

Kyvos API response codes 

REST APIs Reference Guide