Devi Narayanan

HCI REST API

Discussion created by Devi Narayanan on Mar 30, 2017
Latest reply on Apr 13, 2017 by Ben Isherwood

HCI REST API:

We have explored HCI product for the below APIs which can be used as an interface between HCI and Web UI.

Two major categories available in HCI are,

      • Admin API
      • Search API

Admin API:

List of REST API methods available in Admin API are displayed in the below snapshots.

 

 

 

 

Example 1: contentclasses API

Below screenshot shows the usage of contentclasses API.

 

 

When GET Request type available in contentclasses method is clicked, it displays Model Schema, Request URL and Curl command.

 

 

Response body and Response status code will be displayed when user clicks on “Try it out “button highlighted in the above screenshot.

In the below example, response body for GET request type displays all the content classes available in HCI.

 

 

 

 

 

Below screenshot displays GET Request type which takes uuid as input parameter. In our case, we have given uuid value for LnTI_ProcessingReports content class which is available in HCI.

 

 

 

 

Example 2: indexes API

Below screenshot shows the request types available in indexes method.

 

 

Request type GET with input parameter for indexes method is displayed in the below screenshot. When uuid parameter value is specified in request, it fetches specific indexes details from HCI.

 

 

 

Search API :

Below screenshot displays the list of REST API methods available in Search category.

 

 

Example 1: indexes API

Below screenshot displays the request types available in indexes method.

 

 

 

 

 

 

Example 2: query API

Below screenshot displays the request types available in query method.

 

 

Below screenshot displays the parameters which are required for POST Request type available in Query method. In our example, Model schema format which has to be given as input parameter is framed from the format available in data type which is displayed in the right side of parameters section.

 

 

 

 

Note:

Query API under search category shall required to be used for getting the search results and display in Web UI.

Outcomes