API (Application Programming Interface) is a set of rules and protocols that allow different systems or applications to communicate with each other. An API defines how different software components can interact with each other, allowing different systems to be easily integrated and data to be exchanged between them. An API can be used to create applications that use the functions or data of other applications or services.
View all tagsIn this article, we will discuss the description of the TypeCodeRest service. It is a REST service of the logical layer that provides basic methods for retrieving and editing data with the names of case object types. The service has its equivalents supporting the SOAP protocols ITypeCodeAction and Spring Remoting RMI /TypeCodeAction.
In this article, we will describe the TypeKindRest service. It is a REST service of the logical layer that provides basic methods for retrieving and editing data with the names of types of case objects. The service has its equivalents supporting the SOAP protocols ITypeKindAction and Spring Remoting RMI /TypeKindAction.
Below are examples of data aggregation, which were performed via the CaseSearchExtRest#groupByQuery(POST) service. The syntax of the **Group By** clause was described in the article Lucene Index Queries. The examples were performed using the SoapUI tool.
The Mercury DB system offers many services that implement various methods of searching for cases, both in the logical and business layers of the system. In order to standardize and centralize, two main services were created, containing several advanced search methods.
Example//testcluster.hgdb.io/mercury-ws-app/restServices/CaseSearchExtRest.wadl.
Example//testcluster.hgdb.io/mercury-ws-app/restServices/CaseIndexerFieldsManagerRest.wadl.
Mercury DB is a service server (SOAP and REST) that enables the management of any objects, also referred to as cases. The engine is based on the relational SQL model, whereby data is stored in a relational database. The combination of objects and relations allows for the utilization of Mercury DB as an object database, supporting ACID transactions (atomicity, consistency, isolation, durability), as well as integration with traditional BI (business intelligence) systems for business data analysis. It facilitates interconnectivity between the domains of NoSQL databases (e.g., ElasticSearch, MongoDB) and those of relational databases (e.g., Oracle, DB2, PostgreSQL, MySQL).
Metadata retrieval services can be used to build applications presenting data stored in Mercury DB (HgDB) 3.0 (see the description of Mercury Portal 2.0). They can also be used to build a query builder.
The basic search engine in the HgDB database is the Apache Lucene index implementation. Lucene Core is a Java library that provides advanced indexing and search features, as well as spell checking, hit highlighting, and advanced analysis capabilities. This article will describe the rules for creating search and aggregate queries that apply in Mercury DB (HgDb) 3.0.
The service is generated based on the ICaseSearchAction interface, which implements SOAP services.
In this article, we will describe the TypeCaseRest service. It is a REST service of the logical layer that provides basic methods for retrieving and editing data with the names of case object types. The service has its equivalents supporting the SOAP protocols ITypeCaseAction and Spring Remoting RMI /TypeCaseAction.
In this article, we will discuss the description of the TypeCodeWithLastVersionBusinessRest service. It is a REST service of the logical layer that provides basic methods for retrieving and editing data with the names of case object types. The service has its counterparts supporting the OAP protocols ITypeCodeWithLastVersionBusinessAction and Spring Remoting RMI /TypeCodeWithLastVersionBusinessAction.