Skip to main content

Case type kind - processing TypeKind entity data

Info

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.

The WADL definition for the REST service is available at:
https://<hgdb_server_name>[:port]/mercury-ws-app/restServices/TypeKindRest.wadl

Example: https://testcluster.hgdb.io/mercury-ws-app/restServices/TypeKindRest.wadl.

The SOAP service has a WSDL definition available at:
https://<hgdb_server_name>[:port]/mercury-ws-app/services/TypeKindRest?wsdl

Example: https://testcluster.hgdb.io/mercury-ws-app/services/TypeKindRest?wsdl.

Page under construction

The page is under construction and does not contain all the information yet. Please be patient.

TypeKindRest - logical layer service. Responsible for retrieving and updating the TypeKind object. Below is a list of available methods with their descriptions:

Method(HTTP Method)Description
☑️echo(POST)test method, to verify the connection to the MercuryDB 3.0 (HgDB) service server. See the article Testing the connection with Echo.
findAll(POST)get all objects representing object type types.
findByKey(POST)get an object representing an object type based on the key.
findFirst(POST)get the first object representing an object type.
insert(POST)insert a new object representing an object type.
insertBag(POST)insert multiple new objects representing object type types.
remove(POST)remove an object representing an object type.
removeBag(POST)remove multiple objects representing object types.
update(POST)update a object representing an object type.
updateBag(POST)update multiple objects representing object types.
loadNameValuePair(POST)load a name-value pair for an object type.
searchNameValuePairByName(POST)search a name-value pair for an object type by name.